Aspose::Words::Fields Namespace Reference

Detailed Description

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

Classes
class	BarcodeParameters
	Container class for barcode parameters to pass-through to BarcodeGenerator. To learn more, visit the Working with Fields documentation article. More...
class	ComparisonEvaluationResult
	The comparison evaluation result. To learn more, visit the Working with Fields documentation article. More...
class	ComparisonExpression
	The comparison expression. To learn more, visit the Working with Fields documentation article. More...
class	DropDownItemCollection
	A collection of strings that represent all the items in a drop-down form field. To learn more, visit the Working with Fields documentation article. More...
class	Field
	Represents a Microsoft Word document field. To learn more, visit the documentation article. More...
class	FieldAddIn
	Implements the ADDIN field. More...
class	FieldAddressBlock
	Implements the ADDRESSBLOCK field. To learn more, visit the Working with Fields documentation article. More...
class	FieldAdvance
	Implements the ADVANCE field. To learn more, visit the Working with Fields documentation article. More...
class	FieldArgumentBuilder
	Builds a complex field argument consisting of fields, nodes, and plain text. To learn more, visit the Working with Fields documentation article. More...
class	FieldAsk
	Implements the ASK field. To learn more, visit the Working with Fields documentation article. More...
class	FieldAuthor
	Implements the AUTHOR field. To learn more, visit the Working with Fields documentation article. More...
class	FieldAutoNum
	Implements the AUTONUM field. To learn more, visit the Working with Fields documentation article. More...
class	FieldAutoNumLgl
	Implements the AUTONUMLGL field. To learn more, visit the Working with Fields documentation article. More...
class	FieldAutoNumOut
	Implements the AUTONUMOUT field. To learn more, visit the Working with Fields documentation article. More...
class	FieldAutoText
	Implements the AUTOTEXT field. To learn more, visit the Working with Fields documentation article. More...
class	FieldAutoTextList
	Implements the AUTOTEXTLIST field. To learn more, visit the Working with Fields documentation article. More...
class	FieldBarcode
	Implements the BARCODE field. To learn more, visit the Working with Fields documentation article. More...
class	FieldBibliography
	Implements the BIBLIOGRAPHY field. To learn more, visit the Working with Fields documentation article. More...
class	FieldBidiOutline
	Implements the BIDIOUTLINE field. To learn more, visit the Working with Fields documentation article. More...
class	FieldBuilder
	Builds a field from field code tokens (arguments and switches). To learn more, visit the Working with Fields documentation article. More...
class	FieldChar
	Base class for nodes that represent field characters in a document. To learn more, visit the Working with Fields documentation article. More...
class	FieldCitation
	Implements the CITATION field. To learn more, visit the Working with Fields documentation article. More...
class	FieldCollection
	A collection of Field objects that represents the fields in the specified range. To learn more, visit the Working with Fields documentation article. More...
class	FieldComments
	Implements the COMMENTS field. To learn more, visit the Working with Fields documentation article. More...
class	FieldCompare
	Implements the COMPARE field. To learn more, visit the Working with Fields documentation article. More...
class	FieldCreateDate
	Implements the CREATEDATE field. To learn more, visit the Working with Fields documentation article. More...
class	FieldData
	Implements the DATA field. To learn more, visit the Working with Fields documentation article. More...
class	FieldDatabase
	Implements the DATABASE field. To learn more, visit the Working with Fields documentation article. More...
class	FieldDatabaseDataRow
	Provides data for the FieldDatabase field result. To learn more, visit the Working with Fields documentation article. More...
class	FieldDatabaseDataTable
	Provides data for the FieldDatabase field result. To learn more, visit the Working with Fields documentation article. More...
class	FieldDate
	Implements the DATE field. To learn more, visit the Working with Fields documentation article. More...
class	FieldDde
	Implements the DDE field. To learn more, visit the Working with Fields documentation article. More...
class	FieldDdeAuto
	Implements the DDEAUTO field. To learn more, visit the Working with Fields documentation article. More...
class	FieldDisplayBarcode
	Implements the DISPLAYBARCODE field. To learn more, visit the Working with Fields documentation article. More...
class	FieldDocProperty
	Implements the DOCPROPERTY field. To learn more, visit the Working with Fields documentation article. More...
class	FieldDocVariable
	Implements DOCVARIABLE field. To learn more, visit the Working with Fields documentation article. More...
class	FieldEditTime
	Implements the EDITTIME field. To learn more, visit the Working with Fields documentation article. More...
class	FieldEmbed
	Implements the EMBED field. To learn more, visit the Working with Fields documentation article. More...
class	FieldEnd
	Represents an end of a Word field in a document. To learn more, visit the Working with Fields documentation article. More...
class	FieldEQ
	Implements the EQ field. To learn more, visit the Working with Fields documentation article. More...
class	FieldFileName
	Implements the FILENAME field. To learn more, visit the Working with Fields documentation article. More...
class	FieldFileSize
	Implements the FILESIZE field. To learn more, visit the Working with Fields documentation article. More...
class	FieldFillIn
	Implements the FILLIN field. To learn more, visit the Working with Fields documentation article. More...
class	FieldFootnoteRef
	Implements the FOOTNOTEREF field. To learn more, visit the Working with Fields documentation article. More...
class	FieldFormat
	Provides typed access to field's numeric, date and time, and general formatting. To learn more, visit the Working with Fields documentation article. More...
class	FieldFormCheckBox
	Implements the FORMCHECKBOX field. To learn more, visit the Working with Fields documentation article. More...
class	FieldFormDropDown
	Implements the FORMDROPDOWN field. To learn more, visit the Working with Fields documentation article. More...
class	FieldFormText
	Implements the FORMTEXT field. To learn more, visit the Working with Fields documentation article. More...
class	FieldFormula
	Implements the = (formula) field. To learn more, visit the Working with Fields documentation article. More...
class	FieldGlossary
	Implements the GLOSSARY field. To learn more, visit the Working with Fields documentation article. More...
class	FieldGoToButton
	Implements the GOTOBUTTON field. To learn more, visit the Working with Fields documentation article. More...
class	FieldGreetingLine
	Implements the GREETINGLINE field. To learn more, visit the Working with Fields documentation article. More...
class	FieldHyperlink
	Implements the HYPERLINK field To learn more, visit the Working with Fields documentation article. More...
class	FieldIf
	Implements the IF field. To learn more, visit the Working with Fields documentation article. More...
class	FieldImport
	Implements the IMPORT field. To learn more, visit the Working with Fields documentation article. More...
class	FieldInclude
	Implements the INCLUDE field. To learn more, visit the Working with Fields documentation article. More...
class	FieldIncludePicture
	Implements the INCLUDEPICTURE field. To learn more, visit the Working with Fields documentation article. More...
class	FieldIncludeText
	Implements the INCLUDETEXT field. To learn more, visit the Working with Fields documentation article. More...
class	FieldIndex
	Implements the INDEX field. To learn more, visit the Working with Fields documentation article. More...
class	FieldInfo
	Implements the INFO field. To learn more, visit the Working with Fields documentation article. More...
class	FieldKeywords
	Implements the KEYWORDS field. To learn more, visit the Working with Fields documentation article. More...
class	FieldLastSavedBy
	Implements the LASTSAVEDBY field. To learn more, visit the Working with Fields documentation article. More...
class	FieldLink
	Implements the LINK field. To learn more, visit the Working with Fields documentation article. More...
class	FieldListNum
	Implements the LISTNUM field. To learn more, visit the Working with Fields documentation article. More...
class	FieldMacroButton
	Implements the MACROBUTTON field. To learn more, visit the Working with Fields documentation article. More...
class	FieldMergeBarcode
	Implements the MERGEBARCODE field. To learn more, visit the Working with Fields documentation article. More...
class	FieldMergeField
	Implements the MERGEFIELD field. To learn more, visit the Working with Fields documentation article. More...
class	FieldMergeRec
	Implements the MERGEREC field. To learn more, visit the Working with Fields documentation article. More...
class	FieldMergeSeq
	Implements the MERGESEQ field. To learn more, visit the Working with Fields documentation article. More...
class	FieldNext
	Implements the NEXT field. To learn more, visit the Working with Fields documentation article. More...
class	FieldNextIf
	Implements the NEXTIF field. To learn more, visit the Working with Fields documentation article. More...
class	FieldNoteRef
	Implements the NOTEREF field. To learn more, visit the Working with Fields documentation article. More...
class	FieldNumChars
	Implements the NUMCHARS field. To learn more, visit the Working with Fields documentation article. More...
class	FieldNumPages
	Implements the NUMPAGES field. To learn more, visit the Working with Fields documentation article. More...
class	FieldNumWords
	Implements the NUMWORDS field. To learn more, visit the Working with Fields documentation article. More...
class	FieldOcx
	Implements the OCX field. To learn more, visit the Working with Fields documentation article. More...
class	FieldOptions
	Represents options to control field handling in a document. To learn more, visit the Working with Fields documentation article. More...
class	FieldPage
	Implements the PAGE field. To learn more, visit the Working with Fields documentation article. More...
class	FieldPageRef
	Implements the PAGEREF field. To learn more, visit the Working with Fields documentation article. More...
class	FieldPrint
	Implements the PRINT field. To learn more, visit the Working with Fields documentation article. More...
class	FieldPrintDate
	Implements the PRINTDATE field. To learn more, visit the Working with Fields documentation article. More...
class	FieldPrivate
	Implements the PRIVATE field. To learn more, visit the Working with Fields documentation article. More...
class	FieldQuote
	Implements the QUOTE field. To learn more, visit the Working with Fields documentation article. More...
class	FieldRD
	Implements the RD field. To learn more, visit the Working with Fields documentation article. More...
class	FieldRef
	Implements the REF field. To learn more, visit the Working with Fields documentation article. More...
class	FieldRevNum
	Implements the REVNUM field. To learn more, visit the Working with Fields documentation article. More...
class	FieldSaveDate
	Implements the SAVEDATE field. To learn more, visit the Working with Fields documentation article. More...
class	FieldSection
	Implements the SECTION field. To learn more, visit the Working with Fields documentation article. More...
class	FieldSectionPages
	Implements the SECTIONPAGES field. To learn more, visit the Working with Fields documentation article. More...
class	FieldSeparator
	Represents a Word field separator that separates the field code from the field result. To learn more, visit the Working with Fields documentation article. More...
class	FieldSeq
	Implements the SEQ field. To learn more, visit the Working with Fields documentation article. More...
class	FieldSet
	Implements the SET field. To learn more, visit the Working with Fields documentation article. More...
class	FieldShape
	Implements the SHAPE field. To learn more, visit the Working with Fields documentation article. More...
class	FieldSkipIf
	Implements the SKIPIF field. To learn more, visit the Working with Fields documentation article. More...
class	FieldStart
	Represents a start of a Word field in a document. To learn more, visit the Working with Fields documentation article. More...
class	FieldStyleRef
	Implements the STYLEREF field. To learn more, visit the Working with Fields documentation article. More...
class	FieldSubject
	Implements the SUBJECT field. To learn more, visit the Working with Fields documentation article. More...
class	FieldSymbol
	Implements a SYMBOL field. To learn more, visit the Working with Fields documentation article. More...
class	FieldTA
	Implements the TA field. To learn more, visit the Working with Fields documentation article. More...
class	FieldTC
	Implements the TC field. To learn more, visit the Working with Fields documentation article. More...
class	FieldTemplate
	Implements the TEMPLATE field. To learn more, visit the Working with Fields documentation article. More...
class	FieldTime
	Implements the TIME field. To learn more, visit the Working with Fields documentation article. More...
class	FieldTitle
	Implements the TITLE field. To learn more, visit the Working with Fields documentation article. More...
class	FieldToa
	Implements the TOA field. To learn more, visit the Working with Fields documentation article. More...
class	FieldToc
	Implements the TOC field. To learn more, visit the Working with Fields documentation article. More...
class	FieldUnknown
	Implements an unknown or unrecognized field. To learn more, visit the Working with Fields documentation article. More...
class	FieldUpdatingProgressArgs
	Provides data for the field updating progress event. More...
class	FieldUserAddress
	Implements the USERADDRESS field. To learn more, visit the Working with Fields documentation article. More...
class	FieldUserInitials
	Implements the USERINITIALS field. To learn more, visit the Working with Fields documentation article. More...
class	FieldUserName
	Implements the USERNAME field. To learn more, visit the Working with Fields documentation article. More...
class	FieldXE
	Implements the XE field. To learn more, visit the Working with Fields documentation article. More...
class	FormField
	Represents a single form field. To learn more, visit the Working with Form Fields documentation article. More...
class	FormFieldCollection
	A collection of FormField objects that represent all the form fields in a range. To learn more, visit the Working with Form Fields documentation article. More...
class	GeneralFormatCollection
	Represents a typed collection of general formats. To learn more, visit the Working with Fields documentation article. More...
interface	IBarcodeGenerator
	Public interface for barcode custom generator. Implementation should be provided by user. More...
interface	IComparisonExpressionEvaluator
	When implemented, allows to override default comparison expressions evaluation for the FieldIf and FieldCompare fields. More...
interface	IFieldDatabaseProvider
	Implement this interface to provide data for the FieldDatabase field when it's updated. More...
interface	IFieldResultFormatter
	Implement this interface if you want to control how the field result is formatted. More...
interface	IFieldUpdateCultureProvider
	When implemented, provides a CultureInfo object that should be used during the update of a particular field. More...
interface	IFieldUpdatingCallback
	Implement this interface if you want to have your own custom methods called during a field update. More...
interface	IFieldUpdatingProgressCallback
	Implement this interface if you want to track field updating progress. More...
interface	IFieldUserPromptRespondent
	Represents the respondent to user prompts during field update. More...
class	MergeFieldImageDimension
	Represents 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. More...
class	ToaCategories
	Represents a table of authorities categories. To learn more, visit the Working with Fields documentation article. More...
class	UserInformation
	Specifies information about the user. To learn more, visit the Working with Fields documentation article. More...

Enumerations
enum class	FieldDatabaseFormatAttributes
	FieldDatabaseFormatAttributes enumeration. More...
enum class	FieldDatabaseTableFormat
	FieldDatabaseTableFormat enumeration. More...
enum class	FieldIfComparisonResult
	Specifies the result of the IF field condition evaluation. More...
enum class	FieldIndexFormat
	Specifies the formatting for the FieldIndex fields in a document. More...
enum class	FieldType
	Specifies Microsoft Word field types. More...
enum class	FieldUpdateCultureSource
	Indicates what culture to use during field update. More...
enum class	GeneralFormat
	Specifies a general format that is applied to a numeric, text, or any field result. A field may have a combination of general formats. More...
enum class	MergeFieldImageDimensionUnit
	Specifies an unit of an image dimension (i.e. the width or the height) used across a mail merge process. More...
enum class	TextFormFieldType
	Specifies the type of a text form field. More...

Enumeration Type Documentation

FieldDatabaseFormatAttributes

enum class Aspose::Words::Fields::FieldDatabaseFormatAttributes

strong

FieldDatabaseFormatAttributes enumeration.

Enumerator
None
Borders
Shading
Font
Color
AutoFit
FirstRow
LastRow
FirstColumn
LastColumn

FieldDatabaseTableFormat

enum class Aspose::Words::Fields::FieldDatabaseTableFormat

strong

FieldDatabaseTableFormat enumeration.

Enumerator
None
Simple1
Simple2
Simple3
Classic1
Classic2
Classic3
Classic4
Colorful1
Colorful2
Colorful3
Columns1
Columns2
Columns3
Columns4
Columns5
Grid1
Grid2
Grid3
Grid4
Grid5
Grid6
Grid7
Grid8
List1
List2
List3
List4
List5
List6
List7
List8
ThreeDimensionalFx1
ThreeDimensionalFx2
ThreeDimensionalFx3
Contemporary
Elegant
Professional
Subtle1
Subtle2
Web1
Web2
Web3

FieldIfComparisonResult

enum class Aspose::Words::Fields::FieldIfComparisonResult

strong

Specifies the result of the IF field condition evaluation.

Examples

Shows how to insert an IF field.

auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
 
builder->Write(u"Statement 1: ");
auto field = System::DynamicCast<FieldIf>(builder->InsertField(FieldType::FieldIf, true));
field->set_LeftExpression(u"0");
field->set_ComparisonOperator(u"=");
field->set_RightExpression(u"1");
 
// The IF field will display a string from either its "TrueText" property,
// or its "FalseText" property, depending on the truth of the statement that we have constructed.
field->set_TrueText(u"True");
field->set_FalseText(u"False");
field->Update();
 
// In this case, "0 = 1" is incorrect, so the displayed result will be "False".
ASSERT_EQ(u" IF  0 = 1 True False", field->GetFieldCode());
ASSERT_EQ(FieldIfComparisonResult::False, field->EvaluateCondition());
ASSERT_EQ(u"False", field->get_Result());
 
builder->Write(u"\nStatement 2: ");
field = System::DynamicCast<FieldIf>(builder->InsertField(FieldType::FieldIf, true));
field->set_LeftExpression(u"5");
field->set_ComparisonOperator(u"=");
field->set_RightExpression(u"2 + 3");
field->set_TrueText(u"True");
field->set_FalseText(u"False");
field->Update();
 
// This time the statement is correct, so the displayed result will be "True".
ASSERT_EQ(u" IF  5 = \"2 + 3\" True False", field->GetFieldCode());
ASSERT_EQ(FieldIfComparisonResult::True, field->EvaluateCondition());
ASSERT_EQ(u"True", field->get_Result());
 
doc->UpdateFields();
doc->Save(ArtifactsDir + u"Field.IF.docx");

Enumerator
Error	There is an error in the condition.
True	The condition is true.
False	The condition is false.

FieldIndexFormat

enum class Aspose::Words::Fields::FieldIndexFormat

strong

Specifies the formatting for the FieldIndex fields in a document.

Enumerator
Template	From template.
Classic	Classic.
Fancy	Fancy.
Modern	Modern.
Bulleted	Bulleted.
Formal	Formal.
Simple	Simple.

FieldType

enum class Aspose::Words::Fields::FieldType

strong

Specifies Microsoft Word field types.

Examples

Shows how to insert a field into a document using a field code.

auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
 
SharedPtr<Field> field = builder->InsertField(u"DATE \\@ \"dddd, MMMM dd, yyyy\"");
 
ASSERT_EQ(FieldType::FieldDate, field->get_Type());
ASSERT_EQ(u"DATE \\@ \"dddd, MMMM dd, yyyy\"", field->GetFieldCode());
 
// This overload of the InsertField method automatically updates inserted fields.
ASSERT_LE(System::Math::Abs((System::DateTime::Parse(field->get_Result()) - System::DateTime::get_Today()).get_Hours()), 24);

Shows how to work with a FieldStart node.

auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
 
auto field = System::DynamicCast<FieldDate>(builder->InsertField(FieldType::FieldDate, true));
field->get_Format()->set_DateTimeFormat(u"dddd, MMMM dd, yyyy");
field->Update();
 
SharedPtr<FieldChar> fieldStart = field->get_Start();
 
ASSERT_EQ(FieldType::FieldDate, fieldStart->get_FieldType());
ASPOSE_ASSERT_EQ(false, fieldStart->get_IsDirty());
ASPOSE_ASSERT_EQ(false, fieldStart->get_IsLocked());
 
// Retrieve the facade object which represents the field in the document.
field = System::DynamicCast<FieldDate>(fieldStart->GetField());
 
ASPOSE_ASSERT_EQ(false, field->get_IsLocked());
ASSERT_EQ(u" DATE  \\@ \"dddd, MMMM dd, yyyy\"", field->GetFieldCode());
 
// Update the field to show the current date.
field->Update();

Enumerator
FieldNone	Field type is not specified or unknown.
FieldCannotParse	Specifies that the field was unable to be parsed.
FieldAddin	Specifies the ADDIN field.
FieldAddressBlock	Specifies the ADDRESSBLOCK field.
FieldAdvance	Specifies the ADVANCE field.
FieldAsk	Specifies the ASK field.
FieldAuthor	Specifies the AUTHOR field.
FieldAutoNum	Specifies the AUTONUM field.
FieldAutoNumLegal	Specifies the AUTONUMLGL field.
FieldAutoNumOutline	Specifies the AUTONUMOUT field.
FieldAutoText	Specifies the AUTOTEXT field.
FieldAutoTextList	Specifies the AUTOTEXTLIST field.
FieldBarcode	Specifies the BARCODE field.
FieldBibliography	Specifies the BIBLIOGRAPHY field.
FieldBidiOutline	Specifies the BIDIOUTLINE field.
FieldCitation	Specifies the CITATION field.
FieldComments	Specifies the COMMENTS field.
FieldCompare	Specifies the COMPARE field.
FieldCreateDate	Specifies the CREATEDATE field.
FieldData	Specifies the DATA field.
FieldDatabase	Specifies the DATABASE field.
FieldDate	Specifies the DATE field.
FieldDDE	Specifies the DDE field.
FieldDisplayBarcode	Specifies the DISPLAYBARCODE field.
FieldMergeBarcode	Specifies the MERGEBARCODE field.
FieldDDEAuto	Specifies the DDEAUTO field.
FieldDocProperty	Specifies the DOCPROPERTY field.
FieldDocVariable	Specifies the DOCVARIABLE field.
FieldEditTime	Specifies the EDITTIME field.
FieldEmbed	Specifies the EMBED field.
FieldEquation	Specifies the EQ field.
FieldFileName	Specifies the FILENAME field.
FieldFileSize	Specifies the FILESIZE field.
FieldFillIn	Specifies the FILLIN field.
FieldFootnoteRef	Specifies the FOOTNOTEREF field.
FieldFormCheckBox	Specifies the FORMCHECKBOX field.
FieldFormDropDown	Specifies the FORMDROPDOWN field.
FieldFormTextInput	Specifies the FORMTEXT field.
FieldFormula	Specifies the = (formula) field.
FieldGreetingLine	Specifies the GREETINGLINE field.
FieldGlossary	Specifies the GLOSSARY field.
FieldGoToButton	Specifies the GOTOBUTTON field.
FieldHtmlActiveX	Specifies the field that represents an HTML control.
FieldHyperlink	Specifies the HYPERLINK field.
FieldIf	Specifies the IF field.
FieldInclude	Specifies the INCLUDE field.
FieldIncludePicture	Specifies the INCLUDEPICTURE field.
FieldIncludeText	Specifies the INCLUDETEXT field.
FieldIndex	Specifies the INDEX field.
FieldIndexEntry	Specifies the XE field.
FieldInfo	Specifies the INFO field.
FieldImport	Specifies the IMPORT field.
FieldKeyword	Specifies the KEYWORDS field.
FieldLastSavedBy	Specifies the LASTSAVEDBY field.
FieldLink	Specifies the LINK field.
FieldListNum	Specifies the LISTNUM field.
FieldMacroButton	Specifies the MACROBUTTON field.
FieldMergeField	Specifies the MERGEFIELD field.
FieldMergeRec	Specifies the MERGEREC field.
FieldMergeSeq	Specifies the MERGESEQ field.
FieldNext	Specifies the NEXT field.
FieldNextIf	Specifies the NEXTIF field.
FieldNoteRef	Specifies the NOTEREF field.
FieldNumChars	Specifies the NUMCHARS field.
FieldNumPages	Specifies the NUMPAGES field.
FieldNumWords	Specifies the NUMWORDS field.
FieldOcx	Specifies the OCX field. Normally, Aspose.Words will represent an ActiveX control as a Shape object, but for some documents, where a control does not have data and/or seems to be invalid, it will be represented as a field.
FieldPage	Specifies the PAGE field.
FieldPageRef	Specifies the PAGEREF field.
FieldPrint	Specifies the PRINT field.
FieldPrintDate	Specifies the PRINTDATE field.
FieldPrivate	Specifies the PRIVATE field.
FieldQuote	Specifies the QUOTE field.
FieldRef	Specifies the REF field.
FieldRefNoKeyword	Specifies that the field represents a REF field where the keyword has been omitted.
FieldRefDoc	Specifies the RD field.
FieldRevisionNum	Specifies the REVNUM field.
FieldSaveDate	Specifies the SAVEDATE field.
FieldSection	Specifies the SECTION field.
FieldSectionPages	Specifies the SECTIONPAGES field.
FieldSequence	Specifies the SEQ field.
FieldSet	Specifies the SET field.
FieldShape	Specifies the SHAPE field.
FieldSkipIf	Specifies the SKIPIF field.
FieldStyleRef	Specifies the STYLEREF field.
FieldSubject	Specifies the SUBJECT field.
FieldSymbol	Specifies the SYMBOL field.
FieldTemplate	Specifies the TEMPLATE field.
FieldTime	Specifies the TIME field.
FieldTitle	Specifies the TITLE field.
FieldTOA	Specifies the TOA field.
FieldTOAEntry	Specifies the TA field.
FieldTOC	Specifies the TOC field.
FieldTOCEntry	Specifies the TC field.
FieldUserAddress	Specifies the USERADDRESS field.
FieldUserInitials	Specifies the USERINITIALS field.
FieldUserName	Specifies the USERNAME field.

FieldUpdateCultureSource

enum class Aspose::Words::Fields::FieldUpdateCultureSource

strong

Indicates what culture to use during field update.

Enumerator
CurrentThread	The culture of the current execution thread is used to update fields.
FieldCode	The culture specified in the field formatting properties via language setting is used. See also Aspose::Words::Fields::Field::get_LocaleId

GeneralFormat

enum class Aspose::Words::Fields::GeneralFormat

strong

Specifies a general format that is applied to a numeric, text, or any field result. A field may have a combination of general formats.

Examples

Shows how to format field results.

auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
 
// Use a document builder to insert a field that displays a result with no format applied.
SharedPtr<Field> field = builder->InsertField(u"= 2 + 3");
 
ASSERT_EQ(u"= 2 + 3", field->GetFieldCode());
ASSERT_EQ(u"5", field->get_Result());
 
// We can apply a format to a field's result using the field's properties.
// Below are three types of formats that we can apply to a field's result.
// 1 -  Numeric format:
SharedPtr<FieldFormat> format = field->get_Format();
format->set_NumericFormat(u"$###.00");
field->Update();
 
ASSERT_EQ(u"= 2 + 3 \\# $###.00", field->GetFieldCode());
ASSERT_EQ(u"$  5.00", field->get_Result());
 
// 2 -  Date/time format:
field = builder->InsertField(u"DATE");
format = field->get_Format();
format->set_DateTimeFormat(u"dddd, MMMM dd, yyyy");
field->Update();
 
ASSERT_EQ(u"DATE \\@ \"dddd, MMMM dd, yyyy\"", field->GetFieldCode());
std::cout << "Today's date, in " << format->get_DateTimeFormat() << " format:\n\t" << field->get_Result() << std::endl;
 
// 3 -  General format:
field = builder->InsertField(u"= 25 + 33");
format = field->get_Format();
format->get_GeneralFormats()->Add(GeneralFormat::LowercaseRoman);
format->get_GeneralFormats()->Add(GeneralFormat::Upper);
field->Update();
 
int index = 0;
{
    SharedPtr<System::Collections::Generic::IEnumerator<GeneralFormat>> generalFormatEnumerator = format->get_GeneralFormats()->GetEnumerator();
    while (generalFormatEnumerator->MoveNext())
    {
        std::cout << String::Format(u"General format index {0}: {1}", index++, generalFormatEnumerator->get_Current()) << std::endl;
    }
}
 
ASSERT_EQ(u"= 25 + 33 \\* roman \\* Upper", field->GetFieldCode());
ASSERT_EQ(u"LVIII", field->get_Result());
ASSERT_EQ(2, format->get_GeneralFormats()->get_Count());
ASSERT_EQ(GeneralFormat::LowercaseRoman, format->get_GeneralFormats()->idx_get(0));
 
// We can remove our formats to revert the field's result to its original form.
format->get_GeneralFormats()->Remove(GeneralFormat::LowercaseRoman);
format->get_GeneralFormats()->RemoveAt(0);
ASSERT_EQ(0, format->get_GeneralFormats()->get_Count());
field->Update();
 
ASSERT_EQ(u"= 25 + 33  ", field->GetFieldCode());
ASSERT_EQ(u"58", field->get_Result());
ASSERT_EQ(0, format->get_GeneralFormats()->get_Count());

Enumerator
None	Used to specify a missing general format.
Aiueo	Numeric formatting. Formats a numeric result using hiragana characters in the traditional a-i-u-e-o order.
UppercaseAlphabetic	Numeric formatting. Formats a numeric result as one or more occurrences of an uppercase alphabetic Latin character.
LowercaseAlphabetic	Numeric formatting. Formats a numeric result as one or more occurrences of an lowercase alphabetic Latin character.
Arabic	Numeric formatting. Formats a numeric result using Arabic cardinal numerals.
ArabicAbjad	Numeric formatting. Formats a numeric result using ascending Abjad numerals.
ArabicAlpha	Numeric formatting. Formats a numeric result using characters in the Arabic alphabet.
ArabicDash	Numeric formatting. Formats a numeric result using Arabic cardinal numerals, with a prefix of "- " and a suffix of " -".
BahtText	Numeric formatting. Formats a numeric result in the Thai counting system.
CardText	Numeric formatting. Cardinal text (One, Two, Three, ...).
ChineseNum1	Numeric formatting. Formats a numeric result using ascending numbers from the appropriate counting system.
ChineseNum2	Numeric formatting. Formats a numeric result using sequential numbers from the appropriate legal format.
ChineseNum3	Numeric formatting. Formats a numeric result using sequential numbers from the appropriate counting thousand system.
Chosung	Numeric formatting. Formats a numeric result using sequential numbers from the Korean Chosung format.
CircleNum	Numeric formatting. Formats a numeric result using decimal numbering enclosed in a circle, using the enclosed alphanumeric glyph character for numbers in the range 1–20.
DBChar	Numeric formatting. Formats a numeric result using double-byte Arabic numbering.
DBNum1	Numeric formatting. Formats a numeric result using sequential digital ideographs, using the appropriate character.
DBNum2	Numeric formatting. Formats a numeric result using sequential numbers from the appropriate counting system.
DBNum3	Numeric formatting. Formats a numeric result using sequential numbers from the appropriate legal counting system.
DBNum4	Numeric formatting. Formats a numeric result using sequential numbers from the appropriate digital counting system.
DollarText	Numeric formatting. Dollar text (One, Two, Three, ... + AND 55/100).
Ganada	Numeric formatting. Formats a numeric result using sequential numbers from the Korean Ganada format.
GB1	Numeric formatting. Formats a numeric result using decimal numbering followed by a period, using the enclosed alphanumeric glyph character.
GB2	Numeric formatting. Formats a numeric result using decimal numbering enclosed in parenthesis, using the enclosed alphanumeric glyph character.
GB3	Numeric formatting. Formats a numeric result using decimal numbering enclosed in a circle, using the enclosed alphanumeric glyph character.
GB4	Numeric formatting. Formats a numeric result using decimal numbering enclosed in a circle, using the enclosed alphanumeric glyph character.
Hebrew1	Numeric formatting. Formats a numeric result using Hebrew numerals.
Hebrew2	Numeric formatting. Formats a numeric result using the Hebrew alphabet.
Hex	Numeric formatting. Formats the numeric result using uppercase hexadecimal digits.
HindiArabic	Numeric formatting. Formats a numeric result using Hindi numbers.
HindiCardText	Numeric formatting. Formats a numeric result using sequential numbers from the Hindi counting system.
HindiLetter1	Numeric formatting. Formats a numeric result using Hindi vowels.
HindiLetter2	Numeric formatting. Formats a numeric result using Hindi consonants.
Iroha	Numeric formatting. Formats a numeric result using the Japanese iroha.
KanjiNum1	Numeric formatting. Formats a numeric result using a Japanese style using the appropriate counting system.
KanjiNum2	Numeric formatting. Formats a numeric result using the appropriate counting system.
KanjiNum3	Numeric formatting. Formats a numeric result using the appropriate counting system.
Ordinal	Numeric formatting. Ordinal (1st, 2nd, 3rd, ...).
OrdText	Numeric formatting. Ordinal text (First, Second, Third, ...).
UppercaseRoman	Numeric formatting. Uppercase Roman (I, II, III, ...).
LowercaseRoman	Numeric formatting. Lowercase Roman (i, ii, iii, ...).
SBChar	Numeric formatting. Formats a numeric result using single-byte Arabic numbering.
ThaiArabic	Numeric formatting. Formats a numeric result using Thai numbers.
ThaiCardText	Numeric formatting. Formats a numeric result using sequential numbers from the Thai counting system.
ThaiLetter	Numeric formatting. Formats a numeric result using Thai letters.
VietCardText	Numeric formatting. Formats a numeric result using Vietnamese numerals.
Zodiac1	Numeric formatting. Formats a numeric result using sequential numerical traditional ideographs.
Zodiac2	Numeric formatting. Formats a numeric result using sequential zodiac ideographs.
Zodiac3	Numeric formatting. Formats a numeric result using sequential traditional zodiac ideographs.
Caps	Text formatting. Capitalizes the first letter of each word.
FirstCap	Text formatting. Capitalizes the first letter of the first word.
Lower	Text formatting. All letters are lowercase.
Upper	Text formatting. All letters are uppercase.
CharFormat	Field result formatting. The CHARFORMAT instruction.
MergeFormat	Field result formatting. The MERGEFORMAT instruction.
MergeFormatInet	Field result formatting. The MERGEFORMATINET instruction.

MergeFieldImageDimensionUnit

enum class Aspose::Words::Fields::MergeFieldImageDimensionUnit

strong

Specifies an unit of an image dimension (i.e. the width or the height) used across a mail merge process.

Enumerator
Point	The point (i.e. 1/72 inch).
Percent	The percent of the original image dimension value.

TextFormFieldType

enum class Aspose::Words::Fields::TextFormFieldType

strong

Specifies the type of a text form field.

Examples

Shows how to create form fields.

auto builder = MakeObject<DocumentBuilder>();
 
// Form fields are objects in the document that the user can interact with by being prompted to enter values.
// We can create them using a document builder, and below are two ways of doing so.
// 1 -  Basic text input:
builder->InsertTextInput(u"My text input", TextFormFieldType::Regular, u"", u"Enter your name here", 30);
 
// 2 -  Combo box with prompt text, and a range of possible values:
ArrayPtr<String> items = MakeArray<String>({u"-- Select your favorite footwear --", u"Sneakers", u"Oxfords", u"Flip-flops", u"Other"});
 
builder->InsertParagraph();
builder->InsertComboBox(u"My combo box", items, 0);
 
builder->get_Document()->Save(ArtifactsDir + u"DocumentBuilder.CreateForm.docx");

Enumerator
Regular	The text form field can contain any text.
Number	The text form field can contain only numbers.
Date	The text form field can contain only a valid date value.
CurrentDate	The text form field value is the current date when the field is updated.
CurrentTime	The text form field value is the current time when the field is updated.
Calculated	The text form field value is calculated from the expression specified in the TextInputDefault property.