फ़ील्ड्स के साथ काम करना
अवलोकन
एक Word फ़ील्ड – DATE, IF, DATABASE, REF, और कई अन्य – को दर्शाया गया है Aspose.Words FOSS के लिए .NET द्वारा Field क्लास और उसकी सबक्लासेस, सभी Aspose.Words.Fields namespace. यह पृष्ठ कोर फ़ील्ड इंजन को कवर करता है: the Field ऑब्जेक्ट मॉडल स्वयं, फ़ील्ड्स कैसे एकत्रित और अपडेट किए जाते हैं, और वह कॉलबैक इंटरफ़ेस जो फ़ील्ड अपडेट के दौरान कस्टम डेटा और व्यवहार को प्लग इन करने की अनुमति देता है। विशिष्ट फ़ील्ड परिवार – hyperlinks और cross-references, date/time फ़ील्ड्स, mail-merge फ़ील्ड्स, index और table-of-contents फ़ील्ड्स – प्रत्येक का अपना समर्पित developer-guide पृष्ठ है।
फ़ील्ड ऑब्जेक्ट मॉडल
किसी दस्तावेज़ में प्रत्येक फ़ील्ड एक Field इंस्टेंस है, जो तीन मार्कर नोड्स – FieldStart, Separator, और FieldEnd – से बना होता है, और इन्हें Field.Start, Field.Separator, और Field.End प्रॉपर्टीज़ के रूप में उजागर किया जाता है। Field.Type यह पहचानता है कि फ़ील्ड किस FieldType का प्रतिनिधित्व करता है, Field.Result और Field.DisplayResult अंतिम-गणना किए गए मान को उजागर करते हैं, और Field.Format फ़ील्ड कोड से जुड़े किसी भी स्विच (जैसे संख्यात्मक या तिथि-समय फ़ॉर्मेट स्ट्रिंग्स) को रखता है। Field.IsLocked और Field.IsDirty फ़ील्ड की लॉक्ड और स्टेल स्थिति की रिपोर्ट करते हैं। Field.GetFieldCode() को कॉल करके कच्चा फ़ील्ड कोड टेक्स्ट पढ़ें, Field.Update() से परिणाम को पुनः-गणना करें, Field.Unlink() से फ़ील्ड को स्थिर टेक्स्ट से बदलें, और Field.Remove() से उसे पूरी तरह हटाएँ।
दस्तावेज़ में फ़ील्ड्स तक पहुँचना और उन्हें अपडेट करना
Document.Range.Fields एक FieldCollection वापस करता है – उस रेंज में शामिल फ़ील्ड्स, साथ में Count, Remove(), RemoveAt(), और Clear() बल्क रिमूवल के लिए। Range.UpdateFields() रेंज में प्रत्येक फ़ील्ड को पुनः-गणना करता है, Range.UnlinkFields() रेंज में प्रत्येक फ़ील्ड को स्थिर टेक्स्ट में बदलता है, और Range.NormalizeFieldTypes() मैनुअल संपादन के बाद फ़ील्ड के संग्रहीत टाइप कोड को उसके वास्तविक फ़ील्ड कोड के साथ मिलाता है। DocumentBuilder.InsertField() कर्सर पर एक नया फ़ील्ड सम्मिलित करता है, ऐसे ओवरलोड्स के साथ जो या तो नए फ़ील्ड के परिणाम को तुरंत अपडेट करते हैं या इसे बाद के Range.UpdateFields() पास के लिए छोड़ते हैं।
फ़ील्ड अपडेट विकल्प और संस्कृति
Document.FieldOptions एक FieldOptions उदाहरण है जो यह निर्धारित करता है कि पूरे दस्तावेज़ के फ़ील्ड अपडेट होने पर कैसे व्यवहार करेंगे: CurrentUser पहचान फ़ील्ड द्वारा उपयोग किए जाने वाले UserInformation प्रदान करता है, DefaultDocumentAuthor लेखक-संबंधित परिणामों को बीज देता है, LegacyNumberFormat और UseInvariantCultureNumberFormat संख्या स्वरूपण को नियंत्रित करते हैं, और PreProcessCulture और FieldUpdateCultureSource (IFieldUpdateCultureProvider कॉलबैक के साथ जोड़े हुए) यह निर्धारित करते हैं कि अपडेट के दौरान कौन सी संस्कृति तिथि और संख्या स्वरूपण को नियंत्रित करती है। TemplateName, FileName, और BuiltInTemplatesPaths वे मान प्रदान करते हैं जो टेम्प्लेट- और फ़ाइल-नाम-ज्ञात फ़ील्ड वापस पढ़ते हैं।
फ़ील्ड अपडेट को ट्रैक करना और अनुकूलित करना
IFieldUpdatingCallback (FieldUpdating और FieldUpdated) को FieldOptions पर लागू करें ताकि प्रत्येक फ़ील्ड के पुनर्गणना से ठीक पहले और बाद कोड चल सके — यह बैच जॉब में कौन से फ़ील्ड बदल गए हैं, इसका ऑडिट करने में उपयोगी है। IFieldUpdatingProgressCallback (Notify) को लागू करें ताकि बड़े दस्तावेज़ में समग्र प्रगति को ट्रैक किया जा सके; यह एक FieldUpdatingProgressArgs प्राप्त करता है जिसमें TotalFieldsCount, UpdatedFieldsCount, और UpdateCompleted होते हैं। यह बदलने के लिए कि किसी फ़ील्ड का संख्यात्मक या सामान्य परिणाम टेक्स्ट में कैसे प्रदर्शित हो, IFieldResultFormatter (Format(value, format) और FormatNumeric(value, format)) को लागू करें और इसे FieldOptions.ResultFormatter को असाइन करें।
फ़ील्ड्स को बाहरी डेटा प्रदान करना
DATABASE फ़ील्ड अपनी पंक्तियों को IFieldDatabaseProvider.GetQueryResult() के माध्यम से पढ़ता है, जो FieldDatabaseDataRow (Values) उदाहरणों से निर्मित एक FieldDatabaseDataTable (ColumnNames, Rows) लौटाता है — अपनी कार्यान्वयन को FieldOptions.FieldDatabaseProvider को असाइन करें। तुलना फ़ील्ड जैसे IF अपनी शर्त को IComparisonExpressionEvaluator.Evaluate() के माध्यम से मूल्यांकन करते हैं, जो एक ComparisonExpression (LeftExpression, ComparisonOperator, RightExpression) प्राप्त करता है और एक ComparisonEvaluationResult (Result, ErrorMessage) लौटाता है; डिफ़ॉल्ट तुलना तर्क को ओवरराइड करने के लिए एक कस्टम इवैल्युएटर को FieldOptions.ComparisonExpressionEvaluator को असाइन करें। फ़ील्ड्स जो सामान्यतः अपडेट के दौरान उपयोगकर्ता को इनपुट के लिए प्रॉम्प्ट करते हैं — जैसे ASK और FILLIN — जब किसी को FieldOptions.UserPromptRespondent को असाइन किया जाता है तो IFieldUserPromptRespondent.Respond() को कॉल करते हैं, ताकि अनअटेंडेड अपडेट इंटरैक्टिव इनपुट की प्रतीक्षा में ब्लॉक न हो।
फ़ील्ड्स के लिए उपयोगकर्ता और दस्तावेज़ पहचान
UserInformation (Name, Initials, Address, और स्थायी UserInformation.DefaultUser) वह पहचान प्रदान करता है जिससे लेखक- और उपयोगकर्ता-नाम-संबंधित फ़ील्ड पढ़ते हैं। दस्तावेज़ लेखक या उपयोगकर्ता पहचान पर निर्भर फ़ील्ड्स को अपडेट करने से पहले Document.FieldOptions.CurrentUser को एक उदाहरण असाइन करें।
टिप्स और सर्वोत्तम प्रथाएँ
- Aspose.Words FOSS फ़ील्ड्स को लोड या सेव पर स्वचालित रूप से पुनः गणना नहीं करता जैसा कि Word करता है – किसी भी प्रोग्रामेटिक संपादन के बाद जो फ़ील्ड परिणामों में परिलक्षित होना चाहिए,
Range.UpdateFields()(या एकल फ़ील्ड के लिएField.Update()) को स्पष्ट रूप से कॉल करें। FieldStart,Separator, औरFieldEndदस्तावेज़ ट्री में वास्तविक नोड्स हैं; मार्कर नोड्स को सीधे हटाने के बजायField.Remove()याField.Unlink()के माध्यम से फ़ील्ड हटाएँ, अन्यथा फ़ील्ड संरचना असंगत हो सकती है।- वे फ़ील्ड्स जिनका परिणाम पेज लेआउट पर निर्भर करता है —
PAGE,NUMPAGES, और TOC पेज-नंबर एंट्रीज़ — एक प्लेसहोल्डर0के रूप में मूल्यांकित होते हैं, क्योंकि इस संस्करण में पेज-लेआउट/रेंडरिंग इंजन शामिल नहीं है। - यदि आपको ठीक-ठीक कौन से फ़ील्ड बदल गए, इसे लॉग या ऑडिट करने की जरूरत है, तो बड़े या अपरिचित दस्तावेज़ पर
Range.UpdateFields()चलाने से पहलेIFieldUpdatingCallbackको पंजीकृत करें। - एक अनअटेंडेड पाइपलाइन में दस्तावेज़ अपडेट करने से पहले
FieldOptions.UserPromptRespondentसेट करें (या व्यक्तिगत प्रॉम्प्ट-ड्रिवेन फ़ील्ड क्लासेज़ परDefaultResponseमान प्रदान करें), ताकिASK/FILLINफ़ील्ड्स इंटरैक्टिव इनपुट की प्रतीक्षा में रुकें नहीं।
सामान्य समस्याएँ
| समस्या | कारण | समाधान |
|---|---|---|
| दस्तावेज़ को संपादित करने के बाद फ़ील्ड परिणाम पुराना हो गया है | Aspose.Words FOSS लोड या सहेजने पर फ़ील्ड को स्वतः अपडेट नहीं करता | स्पष्ट रूप से Range.UpdateFields() या Field.Update() को कॉल करें |
PAGE, NUMPAGES, या TOC पृष्ठ संख्याएँ 0 दिखाते हैं | पृष्ठ लेआउट/रेंडरिंग इस संस्करण का हिस्सा नहीं है | अपेक्षित व्यवहार – व्यावसायिक संस्करण का उपयोग करें Aspose.Words के लिए .NET यदि आपको गणना किए गए पृष्ठ संख्याओं की आवश्यकता है |
DATABASE फ़ील्ड कोई पंक्तियाँ उत्पन्न नहीं करता | कोई IFieldDatabaseProvider FieldOptions.FieldDatabaseProvider को असाइन नहीं किया गया है | कार्यान्वित करें IFieldDatabaseProvider और इसे Range.UpdateFields() को कॉल करने से पहले असाइन करें |
| बैच फ़ील्ड अपडेट फँस गया प्रतीत होता है | एक प्रॉम्प्ट-ड्रिवन फ़ील्ड (ASK, FILLIN) को कोई IFieldUserPromptRespondent असाइन नहीं किया गया है | FieldOptions.UserPromptRespondent असाइन करें, या फ़ील्ड इंस्टेंस पर DefaultResponse सेट करें |
FAQ
क्या Aspose.Words FOSS हर Word फ़ील्ड प्रकार का मूल्यांकन करता है?
Field ऑब्जेक्ट मॉडल हर FieldType मान का प्रतिनिधित्व करता है और अधिकांश को अपडेट करता है, लेकिन वे फ़ील्ड जिनका परिणाम पेज लेआउट पर निर्भर करता है — जैसे कि PAGE और NUMPAGES — एक प्लेसहोल्डर 0 में मूल्यांकित होते हैं क्योंकि इस संस्करण में लेआउट/रेंडरिंग इंजन शामिल नहीं है।
दस्तावेज़ को प्रोग्रामेटिक रूप से संपादित करने के बाद मैं फ़ील्ड को पुनः-मूल्यांकन कैसे करूँ?
संपादित सामग्री को कवर करने वाली रेंज पर Range.UpdateFields() को कॉल करें, या दस्तावेज़ में प्रत्येक फ़ील्ड को अपडेट करने के लिए Document.Range.UpdateFields() का उपयोग करें।
क्या मैं किसी फ़ील्ड को साधारण, स्थिर पाठ में बदल सकता हूँ?
हां — Field.Unlink() फ़ील्ड को उसके अंतिम-गणना परिणाम के रूप में सामान्य पाठ से बदल देता है, जिससे अंतर्निहित फ़ील्ड कोड हट जाता है।
मैं फ़ील्ड को पूरी तरह से, उसके परिणाम सहित, कैसे हटा सकता हूँ?
Field.Remove() को कॉल करें। यह FieldStart, Separator और FieldEnd नोड्स को फ़ील्ड के कोड और परिणाम सामग्री के साथ ही हटा देता है।
मैं DATABASE फ़ील्ड को कस्टम डेटा कैसे प्रदान करूँ?
IFieldDatabaseProvider को लागू करें और इसे Document.FieldOptions.FieldDatabaseProvider को असाइन करें। आपका GetQueryResult() कार्यान्वयन FieldDatabaseDataRow इंस्टेंस से निर्मित एक FieldDatabaseDataTable लौटाता है।
API Reference सारांश
| क्लास / इंटरफ़ेस | विवरण |
|---|---|
Field | वर्ड फ़ील्ड के लिए बेस क्लास; GetFieldCode(), Update(), Unlink(), Remove() |
FieldCollection | एक रेंज में फ़ील्ड्स, Range.Fields के माध्यम से; Count, Remove(), Clear() |
FieldType | Enum जो यह पहचानता है कि कौन सा Word फ़ील्ड एक Field इंस्टेंस दर्शाता है |
FieldOptions | दस्तावेज़-व्यापी फ़ील्ड अपडेट कॉन्फ़िगरेशन, Document.FieldOptions के माध्यम से |
IFieldUpdatingCallback | FieldUpdating / FieldUpdated हुक्स प्रत्येक फ़ील्ड अपडेट के आसपास |
IFieldUpdatingProgressCallback / FieldUpdatingProgressArgs | बड़े पैमाने पर फ़ील्ड अपडेट के दौरान प्रगति रिपोर्टिंग |
IFieldResultFormatter | फ़ील्ड के गणना किए गए परिणाम की कस्टम फ़ॉर्मेटिंग |
IFieldDatabaseProvider / FieldDatabaseDataTable / FieldDatabaseDataRow | बाहरी डेटा स्रोत DATABASE फ़ील्ड के लिए |
IComparisonExpressionEvaluator / ComparisonExpression / ComparisonEvaluationResult | तुलना-शैली फ़ील्ड अभिव्यक्तियों का कस्टम मूल्यांकन |
IFieldUserPromptRespondent | अनदेखी अपडेट्स में प्रॉम्प्ट-ड्रिवन फ़ील्ड्स के लिए प्रतिक्रियाएँ प्रदान करता है |
IFieldUpdateCultureProvider / FieldUpdateCultureSource | फ़ील्ड अपडेट्स के दौरान संस्कृति चयन |
UserInformation | लेखक/उपयोगकर्ता पहचान (Name, Initials, Address) को पहचान फ़ील्ड्स द्वारा पढ़ा जाता है |