FieldXE class
FieldXE class
Implements the XE field. To learn more, visit the Working with Fields documentation article.
Remarks
Defines the text and page number for an index entry, which is used by an INDEX field.
Constructors
| Name | Description |
|---|---|
| FieldXE() | The default constructor. |
Properties
| Name | Description |
|---|---|
| displayResult | Gets the text that represents the displayed field result. (Inherited from Field) |
| end | Gets the node that represents the field end. (Inherited from Field) |
| entryType | Gets or sets an index entry type. |
| format | Gets a FieldFormat object that provides typed access to field’s formatting. (Inherited from Field) |
| isBold | Gets or sets whether to apply bold formatting to the entry’s page number. |
| isDirty | Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. (Inherited from Field) |
| isItalic | Gets or sets whether to apply italic formatting to the entry’s page number. |
| isLocked | Gets or sets whether the field is locked (should not recalculate its result). (Inherited from Field) |
| localeId | Gets or sets the LCID of the field. (Inherited from Field) |
| pageNumberReplacement | Gets or sets text used in place of a page number. |
| pageRangeBookmarkName | Gets or sets the name of the bookmark that marks a range of pages that is inserted as the entry’s page number. |
| result | Gets or sets text that is between the field separator and field end. (Inherited from Field) |
| separator | Gets the node that represents the field separator. Can be null.(Inherited from Field) |
| start | Gets the node that represents the start of the field. (Inherited from Field) |
| text | Gets or sets the text of the entry. |
| type | Gets the Microsoft Word field type. (Inherited from Field) |
| yomi | Gets or sets the yomi (first phonetic character for sorting indexes) for the index entry |
Methods
| Name | Description |
|---|---|
| asField() | (Inherited from Field) |
| asFieldAddIn() | (Inherited from Field) |
| asFieldAddressBlock() | (Inherited from Field) |
| asFieldAdvance() | (Inherited from Field) |
| asFieldAsk() | (Inherited from Field) |
| asFieldAuthor() | (Inherited from Field) |
| asFieldAutoNum() | (Inherited from Field) |
| asFieldAutoNumLgl() | (Inherited from Field) |
| asFieldAutoNumOut() | (Inherited from Field) |
| asFieldAutoText() | (Inherited from Field) |
| asFieldAutoTextList() | (Inherited from Field) |
| asFieldBarcode() | (Inherited from Field) |
| asFieldBibliography() | (Inherited from Field) |
| asFieldBidiOutline() | (Inherited from Field) |
| asFieldCitation() | (Inherited from Field) |
| asFieldComments() | (Inherited from Field) |
| asFieldCompare() | (Inherited from Field) |
| asFieldCreateDate() | (Inherited from Field) |
| asFieldData() | (Inherited from Field) |
| asFieldDatabase() | (Inherited from Field) |
| asFieldDate() | (Inherited from Field) |
| asFieldDde() | (Inherited from Field) |
| asFieldDdeAuto() | (Inherited from Field) |
| asFieldDisplayBarcode() | (Inherited from Field) |
| asFieldDocProperty() | (Inherited from Field) |
| asFieldDocVariable() | (Inherited from Field) |
| asFieldEQ() | (Inherited from Field) |
| asFieldEditTime() | (Inherited from Field) |
| asFieldEmbed() | (Inherited from Field) |
| asFieldFileName() | (Inherited from Field) |
| asFieldFileSize() | (Inherited from Field) |
| asFieldFillIn() | (Inherited from Field) |
| asFieldFootnoteRef() | (Inherited from Field) |
| asFieldFormCheckBox() | (Inherited from Field) |
| asFieldFormDropDown() | (Inherited from Field) |
| asFieldFormText() | (Inherited from Field) |
| asFieldFormula() | (Inherited from Field) |
| asFieldGlossary() | (Inherited from Field) |
| asFieldGoToButton() | (Inherited from Field) |
| asFieldGreetingLine() | (Inherited from Field) |
| asFieldHyperlink() | (Inherited from Field) |
| asFieldIf() | (Inherited from Field) |
| asFieldImport() | (Inherited from Field) |
| asFieldInclude() | (Inherited from Field) |
| asFieldIncludePicture() | (Inherited from Field) |
| asFieldIncludeText() | (Inherited from Field) |
| asFieldIndex() | (Inherited from Field) |
| asFieldInfo() | (Inherited from Field) |
| asFieldKeywords() | (Inherited from Field) |
| asFieldLastSavedBy() | (Inherited from Field) |
| asFieldLink() | (Inherited from Field) |
| asFieldListNum() | (Inherited from Field) |
| asFieldMacroButton() | (Inherited from Field) |
| asFieldMergeBarcode() | (Inherited from Field) |
| asFieldMergeField() | (Inherited from Field) |
| asFieldMergeRec() | (Inherited from Field) |
| asFieldMergeSeq() | (Inherited from Field) |
| asFieldNext() | (Inherited from Field) |
| asFieldNextIf() | (Inherited from Field) |
| asFieldNoteRef() | (Inherited from Field) |
| asFieldNumChars() | (Inherited from Field) |
| asFieldNumPages() | (Inherited from Field) |
| asFieldNumWords() | (Inherited from Field) |
| asFieldOcx() | (Inherited from Field) |
| asFieldPage() | (Inherited from Field) |
| asFieldPageRef() | (Inherited from Field) |
| asFieldPrint() | (Inherited from Field) |
| asFieldPrintDate() | (Inherited from Field) |
| asFieldPrivate() | (Inherited from Field) |
| asFieldQuote() | (Inherited from Field) |
| asFieldRD() | (Inherited from Field) |
| asFieldRef() | (Inherited from Field) |
| asFieldRevNum() | (Inherited from Field) |
| asFieldSaveDate() | (Inherited from Field) |
| asFieldSection() | (Inherited from Field) |
| asFieldSectionPages() | (Inherited from Field) |
| asFieldSeq() | (Inherited from Field) |
| asFieldSet() | (Inherited from Field) |
| asFieldShape() | (Inherited from Field) |
| asFieldSkipIf() | (Inherited from Field) |
| asFieldStyleRef() | (Inherited from Field) |
| asFieldSubject() | (Inherited from Field) |
| asFieldSymbol() | (Inherited from Field) |
| asFieldTA() | (Inherited from Field) |
| asFieldTC() | (Inherited from Field) |
| asFieldTemplate() | (Inherited from Field) |
| asFieldTime() | (Inherited from Field) |
| asFieldTitle() | (Inherited from Field) |
| asFieldToa() | (Inherited from Field) |
| asFieldToc() | (Inherited from Field) |
| asFieldUnknown() | (Inherited from Field) |
| asFieldUserAddress() | (Inherited from Field) |
| asFieldUserInitials() | (Inherited from Field) |
| asFieldUserName() | (Inherited from Field) |
| asFieldXE() | (Inherited from Field) |
| getFieldCode() | Returns text between field start and field separator (or field end if there is no separator). Both field code and field result of child fields are included. (Inherited from Field) |
| getFieldCode(includeChildFieldCodes) | Returns text between field start and field separator (or field end if there is no separator). (Inherited from Field) |
| remove() | Removes the field from the document. Returns a node right after the field. If the field’s end is the last child of its parent node, returns its parent paragraph. If the field is already removed, returns null.(Inherited from Field) |
| unlink() | Performs the field unlink. (Inherited from Field) |
| update() | Performs the field update. Throws if the field is being updated already. (Inherited from Field) |
| update(ignoreMergeFormat) | Performs a field update. Throws if the field is being updated already. (Inherited from Field) |
See Also
- module Aspose.Words.Fields
- class Field