|
Aspose::Words::Fields::FieldAutoTextList Class Reference
Implements the AUTOTEXTLIST field.
- Examples
Shows how to use an AUTOTEXTLIST field to select from a list of AutoText entries.
void FieldAutoTextList_()
{
auto doc = MakeObject<Document>();
// Create a glossary document and populate it with auto text entries.
doc->set_GlossaryDocument(MakeObject<GlossaryDocument>());
AppendAutoTextEntry(doc->get_GlossaryDocument(), u"AutoText 1", u"Contents of AutoText 1");
AppendAutoTextEntry(doc->get_GlossaryDocument(), u"AutoText 2", u"Contents of AutoText 2");
AppendAutoTextEntry(doc->get_GlossaryDocument(), u"AutoText 3", u"Contents of AutoText 3");
auto builder = MakeObject<DocumentBuilder>(doc);
// Create an AUTOTEXTLIST field and set the text that the field will display in Microsoft Word.
// Set the text to prompt the user to right-click this field to select an AutoText building block,
// whose contents the field will display.
auto field = System::DynamicCast<FieldAutoTextList>(builder->InsertField(FieldType::FieldAutoTextList, true));
field->set_EntryName(u"Right click here to select an AutoText block");
field->set_ListStyle(u"Heading 1");
field->set_ScreenTip(u"Hover tip text for AutoTextList goes here");
ASSERT_EQ(String(u" AUTOTEXTLIST \"Right click here to select an AutoText block\" ") + u"\\s \"Heading 1\" " +
u"\\t \"Hover tip text for AutoTextList goes here\"",
field->GetFieldCode());
doc->Save(ArtifactsDir + u"Field.AUTOTEXTLIST.dotx");
}
static void AppendAutoTextEntry(SharedPtr<GlossaryDocument> glossaryDoc, String name, String contents)
{
auto buildingBlock = MakeObject<BuildingBlock>(glossaryDoc);
buildingBlock->set_Name(name);
buildingBlock->set_Gallery(BuildingBlockGallery::AutoText);
buildingBlock->set_Category(u"General");
buildingBlock->set_Behavior(BuildingBlockBehavior::Paragraph);
auto section = MakeObject<Section>(glossaryDoc);
section->AppendChild(MakeObject<Body>(glossaryDoc));
section->get_Body()->AppendParagraph(contents);
buildingBlock->AppendChild(section);
glossaryDoc->AppendChild(buildingBlock);
}
#include <Aspose.Words.Cpp/Fields/FieldAutoTextList.h>
Inheritance diagram for Aspose::Words::Fields::FieldAutoTextList:
Public Member Functions | |
| String | get_EntryName () |
| Gets or sets the name of the AutoText entry. More... | |
| String | get_ListStyle () |
| Gets or sets the name of the style on which the list to contain entries is based. More... | |
| String | get_ScreenTip () |
| Gets or sets the text of the ScreenTip to show. More... | |
| FieldSwitchType | GetSwitchType (String switchName) override |
| virtual const TypeInfo & | GetType () const override |
| virtual bool | Is (const TypeInfo &target) const override |
| void | set_EntryName (String value) |
| Setter for get_EntryName. More... | |
| void | set_ListStyle (String value) |
| Setter for get_ListStyle. More... | |
| void | set_ScreenTip (String value) |
| Setter for get_ScreenTip. 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 () |
Member Function Documentation
◆ get_EntryName()
| System::String Aspose::Words::Fields::FieldAutoTextList::get_EntryName | ( | ) |
Gets or sets the name of the AutoText entry.
- Examples
Shows how to use an AUTOTEXTLIST field to select from a list of AutoText entries.
void FieldAutoTextList_()
{
auto doc = MakeObject<Document>();
// Create a glossary document and populate it with auto text entries.
doc->set_GlossaryDocument(MakeObject<GlossaryDocument>());
AppendAutoTextEntry(doc->get_GlossaryDocument(), u"AutoText 1", u"Contents of AutoText 1");
AppendAutoTextEntry(doc->get_GlossaryDocument(), u"AutoText 2", u"Contents of AutoText 2");
AppendAutoTextEntry(doc->get_GlossaryDocument(), u"AutoText 3", u"Contents of AutoText 3");
auto builder = MakeObject<DocumentBuilder>(doc);
// Create an AUTOTEXTLIST field and set the text that the field will display in Microsoft Word.
// Set the text to prompt the user to right-click this field to select an AutoText building block,
// whose contents the field will display.
auto field = System::DynamicCast<FieldAutoTextList>(builder->InsertField(FieldType::FieldAutoTextList, true));
field->set_EntryName(u"Right click here to select an AutoText block");
field->set_ListStyle(u"Heading 1");
field->set_ScreenTip(u"Hover tip text for AutoTextList goes here");
ASSERT_EQ(String(u" AUTOTEXTLIST \"Right click here to select an AutoText block\" ") + u"\\s \"Heading 1\" " +
u"\\t \"Hover tip text for AutoTextList goes here\"",
field->GetFieldCode());
doc->Save(ArtifactsDir + u"Field.AUTOTEXTLIST.dotx");
}
static void AppendAutoTextEntry(SharedPtr<GlossaryDocument> glossaryDoc, String name, String contents)
{
auto buildingBlock = MakeObject<BuildingBlock>(glossaryDoc);
buildingBlock->set_Name(name);
buildingBlock->set_Gallery(BuildingBlockGallery::AutoText);
buildingBlock->set_Category(u"General");
buildingBlock->set_Behavior(BuildingBlockBehavior::Paragraph);
auto section = MakeObject<Section>(glossaryDoc);
section->AppendChild(MakeObject<Body>(glossaryDoc));
section->get_Body()->AppendParagraph(contents);
buildingBlock->AppendChild(section);
glossaryDoc->AppendChild(buildingBlock);
}
◆ get_ListStyle()
| System::String Aspose::Words::Fields::FieldAutoTextList::get_ListStyle | ( | ) |
Gets or sets the name of the style on which the list to contain entries is based.
- Examples
Shows how to use an AUTOTEXTLIST field to select from a list of AutoText entries.
void FieldAutoTextList_()
{
auto doc = MakeObject<Document>();
// Create a glossary document and populate it with auto text entries.
doc->set_GlossaryDocument(MakeObject<GlossaryDocument>());
AppendAutoTextEntry(doc->get_GlossaryDocument(), u"AutoText 1", u"Contents of AutoText 1");
AppendAutoTextEntry(doc->get_GlossaryDocument(), u"AutoText 2", u"Contents of AutoText 2");
AppendAutoTextEntry(doc->get_GlossaryDocument(), u"AutoText 3", u"Contents of AutoText 3");
auto builder = MakeObject<DocumentBuilder>(doc);
// Create an AUTOTEXTLIST field and set the text that the field will display in Microsoft Word.
// Set the text to prompt the user to right-click this field to select an AutoText building block,
// whose contents the field will display.
auto field = System::DynamicCast<FieldAutoTextList>(builder->InsertField(FieldType::FieldAutoTextList, true));
field->set_EntryName(u"Right click here to select an AutoText block");
field->set_ListStyle(u"Heading 1");
field->set_ScreenTip(u"Hover tip text for AutoTextList goes here");
ASSERT_EQ(String(u" AUTOTEXTLIST \"Right click here to select an AutoText block\" ") + u"\\s \"Heading 1\" " +
u"\\t \"Hover tip text for AutoTextList goes here\"",
field->GetFieldCode());
doc->Save(ArtifactsDir + u"Field.AUTOTEXTLIST.dotx");
}
static void AppendAutoTextEntry(SharedPtr<GlossaryDocument> glossaryDoc, String name, String contents)
{
auto buildingBlock = MakeObject<BuildingBlock>(glossaryDoc);
buildingBlock->set_Name(name);
buildingBlock->set_Gallery(BuildingBlockGallery::AutoText);
buildingBlock->set_Category(u"General");
buildingBlock->set_Behavior(BuildingBlockBehavior::Paragraph);
auto section = MakeObject<Section>(glossaryDoc);
section->AppendChild(MakeObject<Body>(glossaryDoc));
section->get_Body()->AppendParagraph(contents);
buildingBlock->AppendChild(section);
glossaryDoc->AppendChild(buildingBlock);
}
◆ get_ScreenTip()
| System::String Aspose::Words::Fields::FieldAutoTextList::get_ScreenTip | ( | ) |
Gets or sets the text of the ScreenTip to show.
- Examples
Shows how to use an AUTOTEXTLIST field to select from a list of AutoText entries.
void FieldAutoTextList_()
{
auto doc = MakeObject<Document>();
// Create a glossary document and populate it with auto text entries.
doc->set_GlossaryDocument(MakeObject<GlossaryDocument>());
AppendAutoTextEntry(doc->get_GlossaryDocument(), u"AutoText 1", u"Contents of AutoText 1");
AppendAutoTextEntry(doc->get_GlossaryDocument(), u"AutoText 2", u"Contents of AutoText 2");
AppendAutoTextEntry(doc->get_GlossaryDocument(), u"AutoText 3", u"Contents of AutoText 3");
auto builder = MakeObject<DocumentBuilder>(doc);
// Create an AUTOTEXTLIST field and set the text that the field will display in Microsoft Word.
// Set the text to prompt the user to right-click this field to select an AutoText building block,
// whose contents the field will display.
auto field = System::DynamicCast<FieldAutoTextList>(builder->InsertField(FieldType::FieldAutoTextList, true));
field->set_EntryName(u"Right click here to select an AutoText block");
field->set_ListStyle(u"Heading 1");
field->set_ScreenTip(u"Hover tip text for AutoTextList goes here");
ASSERT_EQ(String(u" AUTOTEXTLIST \"Right click here to select an AutoText block\" ") + u"\\s \"Heading 1\" " +
u"\\t \"Hover tip text for AutoTextList goes here\"",
field->GetFieldCode());
doc->Save(ArtifactsDir + u"Field.AUTOTEXTLIST.dotx");
}
static void AppendAutoTextEntry(SharedPtr<GlossaryDocument> glossaryDoc, String name, String contents)
{
auto buildingBlock = MakeObject<BuildingBlock>(glossaryDoc);
buildingBlock->set_Name(name);
buildingBlock->set_Gallery(BuildingBlockGallery::AutoText);
buildingBlock->set_Category(u"General");
buildingBlock->set_Behavior(BuildingBlockBehavior::Paragraph);
auto section = MakeObject<Section>(glossaryDoc);
section->AppendChild(MakeObject<Body>(glossaryDoc));
section->get_Body()->AppendParagraph(contents);
buildingBlock->AppendChild(section);
glossaryDoc->AppendChild(buildingBlock);
}
◆ GetSwitchType()
|
override |
◆ GetType()
|
overridevirtual |
Reimplemented from Aspose::Words::Fields::Field.
◆ Is()
|
overridevirtual |
Reimplemented from Aspose::Words::Fields::Field.
◆ set_EntryName()
| void Aspose::Words::Fields::FieldAutoTextList::set_EntryName | ( | System::String | value | ) |
◆ set_ListStyle()
| void Aspose::Words::Fields::FieldAutoTextList::set_ListStyle | ( | System::String | value | ) |
◆ set_ScreenTip()
| void Aspose::Words::Fields::FieldAutoTextList::set_ScreenTip | ( | System::String | value | ) |
◆ Type()
|
static |