Click or drag to resize
Aspose.Words.Fields Namespace

The Aspose.Words.Fields namespace contains classes that represent Microsoft Word fields in a document.

Classes
  ClassDescription
Public classCode exampleBarcodeParameters
Container class for barcode parameters to pass-through to BarcodeGenerator.
Public classCode exampleDropDownItemCollection
A collection of strings that represent all the items in a drop-down form field.
Public classCode exampleField
Represents a Microsoft Word document field.
Public classFieldAddIn
Implements the ADDIN field.
Public classCode exampleFieldAddressBlock
Implements the ADDRESSBLOCK field.
Public classCode exampleFieldAdvance
Implements the ADVANCE field.
Public classCode exampleFieldArgumentBuilder
Builds a complex field argument consisting of fields, nodes, and plain text.
Public classCode exampleFieldAsk
Implements the ASK field.
Public classCode exampleFieldAuthor
Implements the AUTHOR field.
Public classCode exampleFieldAutoNum
Implements the AUTONUM field.
Public classCode exampleFieldAutoNumLgl
Implements the AUTONUMLGL field.
Public classCode exampleFieldAutoNumOut
Implements the AUTONUMOUT field.
Public classCode exampleFieldAutoText
Implements the AUTOTEXT field.
Public classCode exampleFieldAutoTextList
Implements the AUTOTEXTLIST field.
Public classCode exampleFieldBarcode
Implements the BARCODE field.
Public classCode exampleFieldBibliography
Implements the BIBLIOGRAPHY field.
Public classFieldBidiOutline
Implements the BIDIOUTLINE field.
Public classCode exampleFieldBuilder
Builds a field from field code tokens (arguments and switches).
Public classCode exampleFieldChar
Base class for nodes that represent field characters in a document.
Public classCode exampleFieldCitation
Implements the CITATION field.
Public classCode exampleFieldCollection
A collection of Field objects that represents the fields in the specified range.
Public classCode exampleFieldComments
Implements the COMMENTS field.
Public classCode exampleFieldCompare
Implements the COMPARE field.
Public classCode exampleFieldCreateDate
Implements the CREATEDATE field.
Public classCode exampleFieldData
Implements the DATA field.
Public classCode exampleFieldDatabase
Implements the DATABASE field.
Public classCode exampleFieldDate
Implements the DATE field.
Public classCode exampleFieldDde
Implements the DDE field.
Public classCode exampleFieldDdeAuto
Implements the DDEAUTO field.
Public classCode exampleFieldDisplayBarcode
Implements the DISPLAYBARCODE field.
Public classCode exampleFieldDocProperty
Implements the DOCPROPERTY field.
Public classCode exampleFieldDocVariable
Implements DOCVARIABLE field.
Public classFieldEditTime
Implements the EDITTIME field.
Public classFieldEmbed
Implements the EMBED field.
Public classCode exampleFieldEnd
Represents an end of a Word field in a document.
Public classFieldEQ
Implements the EQ field.
Public classCode exampleFieldFileName
Implements the FILENAME field.
Public classCode exampleFieldFileSize
Implements the FILESIZE field.
Public classFieldFillIn
Implements the FILLIN field.
Public classFieldFootnoteRef
Implements the FOOTNOTEREF field.
Public classCode exampleFieldFormat
Provides typed access to field's numeric, date and time, and general formatting.
Public classFieldFormCheckBox
Implements the FORMCHECKBOX field.
Public classFieldFormDropDown
Implements the FORMDROPDOWN field.
Public classFieldFormText
Implements the FORMTEXT field.
Public classFieldFormula
Implements the = (formula) field.
Public classFieldGlossary
Implements the GLOSSARY field.
Public classFieldGoToButton
Implements the GOTOBUTTON field.
Remarks
Inserts a jump command, such that when it is activated, the insertion point of the document is moved to the specified location.
Public classCode exampleFieldGreetingLine
Implements the GREETINGLINE field.
Public classCode exampleFieldHyperlink
Implements the HYPERLINK field
Public classCode exampleFieldIf
Implements the IF field.
Public classFieldImport
Implements the IMPORT field.
Public classCode exampleFieldInclude
Implements the INCLUDE field.
Public classCode exampleFieldIncludePicture
Implements the INCLUDEPICTURE field.
Public classCode exampleFieldIncludeText
Implements the INCLUDETEXT field.
Public classCode exampleFieldIndex
Implements the INDEX field.
Public classFieldInfo
Implements the INFO field.
Public classFieldKeywords
Implements the KEYWORDS field.
Public classFieldLastSavedBy
Implements the LASTSAVEDBY field.
Public classCode exampleFieldLink
Implements the LINK field.
Public classCode exampleFieldListNum
Implements the LISTNUM field.
Public classFieldMacroButton
Implements the MACROBUTTON field.
Remarks

Allows a macro or command to be run.

In Aspose.Words this field can also act as a merge field.

Public classFieldMergeBarcode
Implements the MERGEBARCODE field.
Public classCode exampleFieldMergeField
Implements the MERGEFIELD field.
Public classFieldMergeRec
Implements the MERGEREC field.
Public classFieldMergeSeq
Implements the MERGESEQ field.
Public classFieldNext
Implements the NEXT field.
Public classFieldNextIf
Implements the NEXTIF field.
Public classFieldNoteRef
Implements the NOTEREF field.
Public classFieldNumChars
Implements the NUMCHARS field.
Public classFieldNumPages
Implements the NUMPAGES field.
Public classFieldNumWords
Implements the NUMWORDS field.
Public classFieldOcx
Implements the OCX field.
Public classCode exampleFieldOptions
Represents options to control field handling in a document.
Public classFieldPage
Implements the PAGE field.
Public classFieldPageRef
Implements the PAGEREF field.
Public classFieldPrint
Implements the PRINT field.
Public classFieldPrintDate
Implements the PRINTDATE field.
Public classFieldPrivate
Implements the PRIVATE field.
Public classFieldQuote
Implements the QUOTE field.
Public classFieldRD
Implements the RD field.
Public classFieldRef
Implements the REF field.
Public classCode exampleFieldRevNum
Implements the REVNUM field.
Public classFieldSaveDate
Implements the SAVEDATE field.
Public classFieldSection
Implements the SECTION field.
Public classFieldSectionPages
Implements the SECTIONPAGES field.
Public classFieldSeparator
Represents a Word field separator that separates the field code from the field result.
Public classFieldSeq
Implements the SEQ field.
Public classFieldSet
Implements the SET field.
Public classFieldShape
Implements the SHAPE field.
Public classFieldSkipIf
Implements the SKIPIF field.
Public classCode exampleFieldStart
Represents a start of a Word field in a document.
Public classCode exampleFieldStyleRef
Implements the STYLEREF field.
Public classFieldSubject
Implements the SUBJECT field.
Public classFieldSymbol
Implements a SYMBOL field.
Public classFieldTA
Implements the TA field.
Public classCode exampleFieldTC
Implements the TC field.
Public classFieldTemplate
Implements the TEMPLATE field.
Public classFieldTime
Implements the TIME field.
Public classFieldTitle
Implements the TITLE field.
Public classFieldToa
Implements the TOA field.
Public classCode exampleFieldToc
Implements the TOC field.
Public classCode exampleFieldUnknown
Implements an unknown or unrecognized field.
Public classFieldUserAddress
Implements the USERADDRESS field.
Public classFieldUserInitials
Implements the USERINITIALS field.
Public classFieldUserName
Implements the USERNAME field.
Public classCode exampleFieldXE
Implements the XE field.
Public classCode exampleFormField
Represents a single form field.
Public classCode exampleFormFieldCollection
A collection of FormField objects that represent all the form fields in a range.
Public classCode exampleGeneralFormatCollection
Represents a typed collection of general formats.
Public classCode exampleMergeFieldImageDimension
Represents an image dimension (i.e. the width or the height) used across a mail merge process.
Public classCode exampleToaCategories
Represents a table of authorities categories.
Public classCode exampleUserInformation
Specifies information about the user.
Interfaces
  InterfaceDescription
Public interfaceCode exampleIBarcodeGenerator
Public interface for barcode custom generator. Implementation should be provided by user.
Public interfaceCode exampleIFieldResultFormatter
Implement this interface if you want to control how the field result is formatted.
Public interfaceCode exampleIFieldUserPromptRespondent
Represents the respondent to user prompts during field update.
Enumerations
  EnumerationDescription
Public enumerationCode exampleFieldIfComparisonResult
Specifies the result of the IF field condition evaluation.
Public enumerationCode exampleFieldType
Specifies Microsoft Word field types.
Public enumerationCode exampleFieldUpdateCultureSource
Indicates what culture to use during field update.
Public enumerationCode exampleGeneralFormat
Specifies a general format that is applied to a numeric, text, or any field result. A field may have a combination of general formats.
Public enumerationCode exampleMergeFieldImageDimensionUnit
Specifies an unit of an image dimension (i.e. the width or the height) used across a mail merge process.
Public enumerationCode exampleTextFormFieldType
Specifies the type of a text form field.