aspose.words.fields module

The aspose.words.fields module contains classes that represent Microsoft Word fields in a document.

Classes

ClassDescription
BarcodeParametersContainer class for barcode parameters to pass-through to BarcodeGenerator. To learn more, visit the Working with Fields documentation article.
ComparisonEvaluationResultThe comparison evaluation result. To learn more, visit the Working with Fields documentation article.
ComparisonExpressionThe comparison expression. To learn more, visit the Working with Fields documentation article.
DropDownItemCollectionA collection of strings that represent all the items in a drop-down form field. To learn more, visit the Working with Fields documentation article.
FieldRepresents a Microsoft Word document field. To learn more, visit the Working with Fields documentation article.
FieldAddInImplements the ADDIN field.
FieldAddressBlockImplements the ADDRESSBLOCK field. To learn more, visit the Working with Fields documentation article.
FieldAdvanceImplements the ADVANCE field. To learn more, visit the Working with Fields documentation article.
FieldArgumentBuilderBuilds a complex field argument consisting of fields, nodes, and plain text. To learn more, visit the Working with Fields documentation article.
FieldAskImplements the ASK field. To learn more, visit the Working with Fields documentation article.
FieldAuthorImplements the AUTHOR field. To learn more, visit the Working with Fields documentation article.
FieldAutoNumImplements the AUTONUM field. To learn more, visit the Working with Fields documentation article.
FieldAutoNumLglImplements the AUTONUMLGL field. To learn more, visit the Working with Fields documentation article.
FieldAutoNumOutImplements the AUTONUMOUT field. To learn more, visit the Working with Fields documentation article.
FieldAutoTextImplements the AUTOTEXT field. To learn more, visit the Working with Fields documentation article.
FieldAutoTextListImplements the AUTOTEXTLIST field. To learn more, visit the Working with Fields documentation article.
FieldBarcodeImplements the BARCODE field. To learn more, visit the Working with Fields documentation article.
FieldBibliographyImplements the BIBLIOGRAPHY field. To learn more, visit the Working with Fields documentation article.
FieldBidiOutlineImplements the BIDIOUTLINE field. To learn more, visit the Working with Fields documentation article.
FieldBuilderBuilds a field from field code tokens (arguments and switches). To learn more, visit the Working with Fields documentation article.
FieldCharBase class for nodes that represent field characters in a document. To learn more, visit the Working with Fields documentation article.
FieldCitationImplements the CITATION field. To learn more, visit the Working with Fields documentation article.
FieldCollectionA collection of Field objects that represents the fields in the specified range. To learn more, visit the Working with Fields documentation article.
FieldCommentsImplements the COMMENTS field. To learn more, visit the Working with Fields documentation article.
FieldCompareImplements the COMPARE field. To learn more, visit the Working with Fields documentation article.
FieldCreateDateImplements the CREATEDATE field. To learn more, visit the Working with Fields documentation article.
FieldDataImplements the DATA field. To learn more, visit the Working with Fields documentation article.
FieldDatabaseImplements the DATABASE field. To learn more, visit the Working with Fields documentation article.
FieldDatabaseDataRowProvides data for the FieldDatabase field result. To learn more, visit the Working with Fields documentation article.
FieldDatabaseDataTableProvides data for the FieldDatabase field result. To learn more, visit the Working with Fields documentation article.
FieldDateImplements the DATE field. To learn more, visit the Working with Fields documentation article.
FieldDdeImplements the DDE field. To learn more, visit the Working with Fields documentation article.
FieldDdeAutoImplements the DDEAUTO field. To learn more, visit the Working with Fields documentation article.
FieldDisplayBarcodeImplements the DISPLAYBARCODE field. To learn more, visit the Working with Fields documentation article.
FieldDocPropertyImplements the DOCPROPERTY field. To learn more, visit the Working with Fields documentation article.
FieldDocVariableImplements DOCVARIABLE field. To learn more, visit the Working with Fields documentation article.
FieldEQImplements the EQ field. To learn more, visit the Working with Fields documentation article.
FieldEditTimeImplements the EDITTIME field. To learn more, visit the Working with Fields documentation article.
FieldEmbedImplements the EMBED field. To learn more, visit the Working with Fields documentation article.
FieldEndRepresents an end of a Word field in a document. To learn more, visit the Working with Fields documentation article.
FieldFileNameImplements the FILENAME field. To learn more, visit the Working with Fields documentation article.
FieldFileSizeImplements the FILESIZE field. To learn more, visit the Working with Fields documentation article.
FieldFillInImplements the FILLIN field. To learn more, visit the Working with Fields documentation article.
FieldFootnoteRefImplements the FOOTNOTEREF field. To learn more, visit the Working with Fields documentation article.
FieldFormCheckBoxImplements the FORMCHECKBOX field. To learn more, visit the Working with Fields documentation article.
FieldFormDropDownImplements the FORMDROPDOWN field. To learn more, visit the Working with Fields documentation article.
FieldFormTextImplements the FORMTEXT field. To learn more, visit the Working with Fields documentation article.
FieldFormatProvides typed access to field’s numeric, date and time, and general formatting. To learn more, visit the Working with Fields documentation article.
FieldFormulaImplements the = (formula) field. To learn more, visit the Working with Fields documentation article.
FieldGlossaryImplements the GLOSSARY field. To learn more, visit the Working with Fields documentation article.
FieldGoToButtonImplements the GOTOBUTTON field. To learn more, visit the Working with Fields documentation article.
FieldGreetingLineImplements the GREETINGLINE field. To learn more, visit the Working with Fields documentation article.
FieldHyperlinkImplements the HYPERLINK field To learn more, visit the Working with Fields documentation article.
FieldIfImplements the IF field. To learn more, visit the Working with Fields documentation article.
FieldImportImplements the IMPORT field. To learn more, visit the Working with Fields documentation article.
FieldIncludeImplements the INCLUDE field. To learn more, visit the Working with Fields documentation article.
FieldIncludePictureImplements the INCLUDEPICTURE field. To learn more, visit the Working with Fields documentation article.
FieldIncludeTextImplements the INCLUDETEXT field. To learn more, visit the Working with Fields documentation article.
FieldIndexImplements the INDEX field. To learn more, visit the Working with Fields documentation article.
FieldInfoImplements the INFO field. To learn more, visit the Working with Fields documentation article.
FieldKeywordsImplements the KEYWORDS field. To learn more, visit the Working with Fields documentation article.
FieldLastSavedByImplements the LASTSAVEDBY field. To learn more, visit the Working with Fields documentation article.
FieldLinkImplements the LINK field. To learn more, visit the Working with Fields documentation article.
FieldListNumImplements the LISTNUM field. To learn more, visit the Working with Fields documentation article.
FieldMacroButtonImplements the MACROBUTTON field. To learn more, visit the Working with Fields documentation article.
FieldMergeBarcodeImplements the MERGEBARCODE field. To learn more, visit the Working with Fields documentation article.
FieldMergeFieldImplements the MERGEFIELD field. To learn more, visit the Working with Fields documentation article.
FieldMergeRecImplements the MERGEREC field. To learn more, visit the Working with Fields documentation article.
FieldMergeSeqImplements the MERGESEQ field. To learn more, visit the Working with Fields documentation article.
FieldNextImplements the NEXT field. To learn more, visit the Working with Fields documentation article.
FieldNextIfImplements the NEXTIF field. To learn more, visit the Working with Fields documentation article.
FieldNoteRefImplements the NOTEREF field. To learn more, visit the Working with Fields documentation article.
FieldNumCharsImplements the NUMCHARS field. To learn more, visit the Working with Fields documentation article.
FieldNumPagesImplements the NUMPAGES field. To learn more, visit the Working with Fields documentation article.
FieldNumWordsImplements the NUMWORDS field. To learn more, visit the Working with Fields documentation article.
FieldOcxImplements the OCX field. To learn more, visit the Working with Fields documentation article.
FieldOptionsRepresents options to control field handling in a document. To learn more, visit the Working with Fields documentation article.
FieldPageImplements the PAGE field. To learn more, visit the Working with Fields documentation article.
FieldPageRefImplements the PAGEREF field. To learn more, visit the Working with Fields documentation article.
FieldPrintImplements the PRINT field. To learn more, visit the Working with Fields documentation article.
FieldPrintDateImplements the PRINTDATE field. To learn more, visit the Working with Fields documentation article.
FieldPrivateImplements the PRIVATE field. To learn more, visit the Working with Fields documentation article.
FieldQuoteImplements the QUOTE field. To learn more, visit the Working with Fields documentation article.
FieldRDImplements the RD field. To learn more, visit the Working with Fields documentation article.
FieldRefImplements the REF field. To learn more, visit the Working with Fields documentation article.
FieldRevNumImplements the REVNUM field. To learn more, visit the Working with Fields documentation article.
FieldSaveDateImplements the SAVEDATE field. To learn more, visit the Working with Fields documentation article.
FieldSectionImplements the SECTION field. To learn more, visit the Working with Fields documentation article.
FieldSectionPagesImplements the SECTIONPAGES field. To learn more, visit the Working with Fields documentation article.
FieldSeparatorRepresents a Word field separator that separates the field code from the field result. To learn more, visit the Working with Fields documentation article.
FieldSeqImplements the SEQ field. To learn more, visit the Working with Fields documentation article.
FieldSetImplements the SET field. To learn more, visit the Working with Fields documentation article.
FieldShapeImplements the SHAPE field. To learn more, visit the Working with Fields documentation article.
FieldSkipIfImplements the SKIPIF field. To learn more, visit the Working with Fields documentation article.
FieldStartRepresents a start of a Word field in a document. To learn more, visit the Working with Fields documentation article.
FieldStyleRefImplements the STYLEREF field. To learn more, visit the Working with Fields documentation article.
FieldSubjectImplements the SUBJECT field. To learn more, visit the Working with Fields documentation article.
FieldSymbolImplements a SYMBOL field. To learn more, visit the Working with Fields documentation article.
FieldTAImplements the TA field. To learn more, visit the Working with Fields documentation article.
FieldTCImplements the TC field. To learn more, visit the Working with Fields documentation article.
FieldTemplateImplements the TEMPLATE field. To learn more, visit the Working with Fields documentation article.
FieldTimeImplements the TIME field. To learn more, visit the Working with Fields documentation article.
FieldTitleImplements the TITLE field. To learn more, visit the Working with Fields documentation article.
FieldToaImplements the TOA field. To learn more, visit the Working with Fields documentation article.
FieldTocImplements the TOC field. To learn more, visit the Working with Fields documentation article.
FieldUnknownImplements an unknown or unrecognized field. To learn more, visit the Working with Fields documentation article.
FieldUpdatingProgressArgsProvides data for the field updating progress event.
FieldUserAddressImplements the USERADDRESS field. To learn more, visit the Working with Fields documentation article.
FieldUserInitialsImplements the USERINITIALS field. To learn more, visit the Working with Fields documentation article.
FieldUserNameImplements the USERNAME field. To learn more, visit the Working with Fields documentation article.
FieldXEImplements the XE field. To learn more, visit the Working with Fields documentation article.
FormFieldRepresents a single form field. To learn more, visit the Working with Form Fields documentation article.
FormFieldCollectionA collection of FormField objects that represent all the form fields in a range. To learn more, visit the Working with Form Fields documentation article.
GeneralFormatCollectionRepresents a typed collection of general formats. To learn more, visit the Working with Fields documentation article.
IBarcodeGeneratorPublic interface for barcode custom generator. Implementation should be provided by user.
IBibliographyStylesProviderImplement this interface to provide bibliography style for the FieldBibliography and FieldCitation fields when they’re updated.
IComparisonExpressionEvaluatorWhen implemented, allows to override default comparison expressions evaluation for the FieldIf and FieldCompare fields.
IFieldDatabaseProviderImplement this interface to provide data for the FieldDatabase field when it’s updated.
IFieldResultFormatterImplement this interface if you want to control how the field result is formatted.
IFieldUpdateCultureProviderWhen implemented, provides a System.Globalization.CultureInfo object that should be used during the update of a particular field.
IFieldUpdatingCallbackImplement this interface if you want to have your own custom methods called during a field update.
IFieldUpdatingProgressCallbackImplement this interface if you want to track field updating progress.
IFieldUserPromptRespondentRepresents the respondent to user prompts during field update.
MergeFieldImageDimensionRepresents an image dimension (i.e. the width or the height) used across a mail merge process. To learn more, visit the Working with Fields documentation article.
ToaCategoriesRepresents a table of authorities categories. To learn more, visit the Working with Fields documentation article.
UserInformationSpecifies information about the user. To learn more, visit the Working with Fields documentation article.

Enumerations

EnumerationDescription
FieldIfComparisonResultSpecifies the result of the IF field condition evaluation.
FieldIndexFormatSpecifies the formatting for the FieldIndex fields in a document.
FieldTypeSpecifies Microsoft Word field types.
FieldUpdateCultureSourceIndicates what culture to use during field update.
GeneralFormatSpecifies a general format that is applied to a numeric, text, or any field result. A field may have a combination of general formats.
MergeFieldImageDimensionUnitSpecifies an unit of an image dimension (i.e. the width or the height) used across a mail merge process.
TextFormFieldTypeSpecifies the type of a text form field.