|
Aspose::Words::Fields::FieldAuthor Class Reference
Implements the AUTHOR field.
- Examples
Shows how to use an AUTHOR field to display a document creator's name.
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
// AUTHOR fields source their results from the built-in document property called "Author".
// If we create and save a document in Microsoft Word,
// it will have our username in that property.
// However, if we create a document programmatically using Aspose.Words,
// the "Author" property, by default, will be an empty string.
ASSERT_EQ(String::Empty, doc->get_BuiltInDocumentProperties()->get_Author());
// Set a backup author name for AUTHOR fields to use
// if the "Author" property contains an empty string.
doc->get_FieldOptions()->set_DefaultDocumentAuthor(u"Joe Bloggs");
builder->Write(u"This document was created by ");
field->Update();
ASSERT_EQ(u" AUTHOR ", field->GetFieldCode());
ASSERT_EQ(u"Joe Bloggs", field->get_Result());
// Updating an AUTHOR field that contains a value
// will apply that value to the "Author" built-in property.
ASSERT_EQ(u"Joe Bloggs", doc->get_BuiltInDocumentProperties()->get_Author());
// Changing this property, then updating the AUTHOR field will apply this value to the field.
doc->get_BuiltInDocumentProperties()->set_Author(u"John Doe");
field->Update();
ASSERT_EQ(u" AUTHOR ", field->GetFieldCode());
ASSERT_EQ(u"John Doe", field->get_Result());
// If we update an AUTHOR field after changing its "Name" property,
// then the field will display the new name and apply the new name to the built-in property.
field->set_AuthorName(u"Jane Doe");
field->Update();
ASSERT_EQ(u" AUTHOR \"Jane Doe\"", field->GetFieldCode());
ASSERT_EQ(u"Jane Doe", field->get_Result());
// AUTHOR fields do not affect the DefaultDocumentAuthor property.
ASSERT_EQ(u"Jane Doe", doc->get_BuiltInDocumentProperties()->get_Author());
ASSERT_EQ(u"Joe Bloggs", doc->get_FieldOptions()->get_DefaultDocumentAuthor());
doc->Save(ArtifactsDir + u"Field.AUTHOR.docx");
#include <Aspose.Words.Cpp/Fields/FieldAuthor.h>
Inheritance diagram for Aspose::Words::Fields::FieldAuthor:
Public Member Functions | |
| String | get_AuthorName () |
| Gets or sets the document author's name. More... | |
| virtual const TypeInfo & | GetType () const override |
| virtual bool | Is (const TypeInfo &target) const override |
| void | set_AuthorName (String value) |
| Setter for get_AuthorName. 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_AuthorName()
| System::String Aspose::Words::Fields::FieldAuthor::get_AuthorName | ( | ) |
Gets or sets the document author's name.
- Examples
Shows how to use an AUTHOR field to display a document creator's name.
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
// AUTHOR fields source their results from the built-in document property called "Author".
// If we create and save a document in Microsoft Word,
// it will have our username in that property.
// However, if we create a document programmatically using Aspose.Words,
// the "Author" property, by default, will be an empty string.
ASSERT_EQ(String::Empty, doc->get_BuiltInDocumentProperties()->get_Author());
// Set a backup author name for AUTHOR fields to use
// if the "Author" property contains an empty string.
doc->get_FieldOptions()->set_DefaultDocumentAuthor(u"Joe Bloggs");
builder->Write(u"This document was created by ");
field->Update();
ASSERT_EQ(u" AUTHOR ", field->GetFieldCode());
ASSERT_EQ(u"Joe Bloggs", field->get_Result());
// Updating an AUTHOR field that contains a value
// will apply that value to the "Author" built-in property.
ASSERT_EQ(u"Joe Bloggs", doc->get_BuiltInDocumentProperties()->get_Author());
// Changing this property, then updating the AUTHOR field will apply this value to the field.
doc->get_BuiltInDocumentProperties()->set_Author(u"John Doe");
field->Update();
ASSERT_EQ(u" AUTHOR ", field->GetFieldCode());
ASSERT_EQ(u"John Doe", field->get_Result());
// If we update an AUTHOR field after changing its "Name" property,
// then the field will display the new name and apply the new name to the built-in property.
field->set_AuthorName(u"Jane Doe");
field->Update();
ASSERT_EQ(u" AUTHOR \"Jane Doe\"", field->GetFieldCode());
ASSERT_EQ(u"Jane Doe", field->get_Result());
// AUTHOR fields do not affect the DefaultDocumentAuthor property.
ASSERT_EQ(u"Jane Doe", doc->get_BuiltInDocumentProperties()->get_Author());
ASSERT_EQ(u"Joe Bloggs", doc->get_FieldOptions()->get_DefaultDocumentAuthor());
doc->Save(ArtifactsDir + u"Field.AUTHOR.docx");
◆ GetType()
|
overridevirtual |
Reimplemented from Aspose::Words::Fields::Field.
◆ Is()
|
overridevirtual |
Reimplemented from Aspose::Words::Fields::Field.
◆ set_AuthorName()
| void Aspose::Words::Fields::FieldAuthor::set_AuthorName | ( | System::String | value | ) |
◆ Type()
|
static |