|
Aspose::Words::Fields::FieldGreetingLine Class Reference
Implements the GREETINGLINE field.
#include <Aspose.Words.Cpp/Fields/FieldGreetingLine.h>
Inheritance diagram for Aspose::Words::Fields::FieldGreetingLine:
Public Member Functions | |
| FieldGreetingLine () | |
| String | get_AlternateText () |
| Gets the text to include in the field if the name is blank. More... | |
| String | get_LanguageId () |
| Gets the language id used to format the name. More... | |
| String | get_MergeFormat () override |
| String | get_NameFormat () |
| Gets the format of the name included in the field. More... | |
| SharedPtr< Aspose::Collections::StringToObjDictionary< String > > | get_PlaceholdersToFieldsMap () override |
| ArrayPtr< String > | GetFieldNames () override |
| Returns a collection of mail merge field names used by the field. More... | |
| String | GetPlaceholderValue (SharedPtr< Aspose::Words::Fields::IMergeFormatContext > context, SharedPtr< Aspose::Words::Fields::MergeFormatPlaceholder > placeholder) override |
| FieldSwitchType | GetSwitchType (String switchName) override |
| virtual const TypeInfo & | GetType () const override |
| SharedPtr< Document > | IFormattableMergeField_FetchDocument () override |
| virtual bool | Is (const TypeInfo &target) const override |
| void | set_AlternateText (String value) |
| Sets the text to include in the field if the name is blank. More... | |
| void | set_LanguageId (String value) |
| Sets the language id used to format the name. More... | |
| void | set_NameFormat (String value) |
| Sets the format of the name included in the field. More... | |
| Public Member Functions inherited from Field | |
| String | get_DisplayResult () |
| Gets the text that represents the displayed field result. More... | |
| SharedPtr< FieldEnd > | get_End () const |
| Gets the node that represents the field end. More... | |
| SharedPtr< FieldEnd > | get_FieldEnd () const |
| Gets the node that represents the field end. More... | |
| SharedPtr< FieldStart > | get_FieldStart () const |
| Gets the node that represents the start of the field. More... | |
| SharedPtr< FieldFormat > | get_Format () |
| Gets a FieldFormat object that provides typed access to field's formatting. More... | |
| bool | get_IsDirty () |
| Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. More... | |
| bool | get_IsLocked () |
| Gets or sets whether the field is locked (should not recalculate its result). More... | |
| int32_t | get_LocaleId () |
| Gets or sets the LCID of the field. More... | |
| String | get_Result () |
| Gets or sets text that is between the field separator and field end. More... | |
| SharedPtr< FieldSeparator > | get_Separator () |
| Gets the node that represents the field separator. Can be null. More... | |
| SharedPtr< FieldStart > | get_Start () const |
| Gets the node that represents the start of the field. More... | |
| virtual FieldType | get_Type () |
| Gets the Microsoft Word field type. More... | |
| String | 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. More... | |
| String | GetFieldCode (bool includeChildFieldCodes) |
| Returns text between field start and field separator (or field end if there is no separator). More... | |
| SharedPtr< Node > | 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. More... | |
| void | set_IsDirty (bool value) |
| Setter for get_IsDirty. More... | |
| void | set_IsLocked (bool value) |
| Setter for get_IsLocked. More... | |
| void | set_LocaleId (int32_t value) |
| Setter for get_LocaleId. More... | |
| void | set_Result (String value) |
| Setter for get_Result. More... | |
| bool | Unlink () |
| Performs the field unlink. More... | |
| void | Update () |
| Performs the field update. Throws if the field is being updated already. More... | |
| void | Update (bool ignoreMergeFormat) |
| Performs a field update. Throws if the field is being updated already. More... | |
Static Public Member Functions | |
| static const TypeInfo & | Type () |
| Static Public Member Functions inherited from Field | |
| static const TypeInfo & | Type () |
Constructor & Destructor Documentation
◆ FieldGreetingLine()
| Aspose::Words::Fields::FieldGreetingLine::FieldGreetingLine | ( | ) |
Member Function Documentation
◆ get_AlternateText()
| System::String Aspose::Words::Fields::FieldGreetingLine::get_AlternateText | ( | ) |
Gets the text to include in the field if the name is blank.
◆ get_LanguageId()
| System::String Aspose::Words::Fields::FieldGreetingLine::get_LanguageId | ( | ) |
Gets the language id used to format the name.
◆ get_MergeFormat()
|
override |
◆ get_NameFormat()
| System::String Aspose::Words::Fields::FieldGreetingLine::get_NameFormat | ( | ) |
Gets the format of the name included in the field.
◆ get_PlaceholdersToFieldsMap()
|
override |
◆ GetFieldNames()
|
override |
Returns a collection of mail merge field names used by the field.
◆ GetPlaceholderValue()
|
override |
◆ GetSwitchType()
|
override |
◆ GetType()
|
overridevirtual |
Reimplemented from Aspose::Words::Fields::Field.
◆ IFormattableMergeField_FetchDocument()
|
override |
◆ Is()
|
overridevirtual |
Reimplemented from Aspose::Words::Fields::Field.
◆ set_AlternateText()
| void Aspose::Words::Fields::FieldGreetingLine::set_AlternateText | ( | System::String | value | ) |
Sets the text to include in the field if the name is blank.
◆ set_LanguageId()
| void Aspose::Words::Fields::FieldGreetingLine::set_LanguageId | ( | System::String | value | ) |
Sets the language id used to format the name.
◆ set_NameFormat()
| void Aspose::Words::Fields::FieldGreetingLine::set_NameFormat | ( | System::String | value | ) |
Sets the format of the name included in the field.
◆ Type()
|
static |