|
Aspose::Words::Fields::FieldUserName Class Reference
Implements the USERNAME field.
- Examples
Shows how to use the USERNAME field.
auto doc = MakeObject<Document>();
// Create a UserInformation object and set it as the source of user information for any fields that we create.
auto userInformation = MakeObject<UserInformation>();
userInformation->set_Name(u"John Doe");
doc->get_FieldOptions()->set_CurrentUser(userInformation);
auto builder = MakeObject<DocumentBuilder>(doc);
// Create a USERNAME field to display the current user's name,
// taken from the UserInformation object we created above.
auto fieldUserName = System::DynamicCast<FieldUserName>(builder->InsertField(FieldType::FieldUserName, true));
ASSERT_EQ(userInformation->get_Name(), fieldUserName->get_Result());
ASSERT_EQ(u" USERNAME ", fieldUserName->GetFieldCode());
ASSERT_EQ(u"John Doe", fieldUserName->get_Result());
// We can set this property to get our field to override the value currently stored in the UserInformation object.
fieldUserName->set_UserName(u"Jane Doe");
fieldUserName->Update();
ASSERT_EQ(u" USERNAME \"Jane Doe\"", fieldUserName->GetFieldCode());
ASSERT_EQ(u"Jane Doe", fieldUserName->get_Result());
// This does not affect the value in the UserInformation object.
ASSERT_EQ(u"John Doe", doc->get_FieldOptions()->get_CurrentUser()->get_Name());
doc->UpdateFields();
doc->Save(ArtifactsDir + u"Field.USERNAME.docx");
#include <Aspose.Words.Cpp/Fields/FieldUserName.h>
Inheritance diagram for Aspose::Words::Fields::FieldUserName:
Public Member Functions | |
| String | get_UserName () |
| Gest or sets the current user's name. More... | |
| virtual const TypeInfo & | GetType () const override |
| virtual bool | Is (const TypeInfo &target) const override |
| void | set_UserName (String value) |
| Setter for get_UserName. 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_UserName()
| System::String Aspose::Words::Fields::FieldUserName::get_UserName | ( | ) |
Gest or sets the current user's name.
- Examples
Shows how to use the USERNAME field.
auto doc = MakeObject<Document>();
// Create a UserInformation object and set it as the source of user information for any fields that we create.
auto userInformation = MakeObject<UserInformation>();
userInformation->set_Name(u"John Doe");
doc->get_FieldOptions()->set_CurrentUser(userInformation);
auto builder = MakeObject<DocumentBuilder>(doc);
// Create a USERNAME field to display the current user's name,
// taken from the UserInformation object we created above.
auto fieldUserName = System::DynamicCast<FieldUserName>(builder->InsertField(FieldType::FieldUserName, true));
ASSERT_EQ(userInformation->get_Name(), fieldUserName->get_Result());
ASSERT_EQ(u" USERNAME ", fieldUserName->GetFieldCode());
ASSERT_EQ(u"John Doe", fieldUserName->get_Result());
// We can set this property to get our field to override the value currently stored in the UserInformation object.
fieldUserName->set_UserName(u"Jane Doe");
fieldUserName->Update();
ASSERT_EQ(u" USERNAME \"Jane Doe\"", fieldUserName->GetFieldCode());
ASSERT_EQ(u"Jane Doe", fieldUserName->get_Result());
// This does not affect the value in the UserInformation object.
ASSERT_EQ(u"John Doe", doc->get_FieldOptions()->get_CurrentUser()->get_Name());
doc->UpdateFields();
doc->Save(ArtifactsDir + u"Field.USERNAME.docx");
◆ GetType()
|
overridevirtual |
Reimplemented from Aspose::Words::Fields::Field.
◆ Is()
|
overridevirtual |
Reimplemented from Aspose::Words::Fields::Field.
◆ set_UserName()
| void Aspose::Words::Fields::FieldUserName::set_UserName | ( | System::String | value | ) |
◆ Type()
|
static |