Aspose::Words::Fields::UserInformation class
Contents
[
Hide
]UserInformation class
Specifies information about the user. To learn more, visit the Working with Fields documentation article.
class UserInformation : public System::Object
Methods
| Method | Description |
|---|---|
| get_Address() const | Gets or sets the user’s postal address. |
| static get_DefaultUser() | Default user information. |
| get_Initials() const | Gets or sets the user’s initials. |
| get_Name() const | Gets or sets the user’s name. |
| GetType() const override | |
| Is(const System::TypeInfo&) const override | |
| set_Address(const System::String&) | Setter for Aspose::Words::Fields::UserInformation::get_Address. |
| set_Initials(const System::String&) | Setter for Aspose::Words::Fields::UserInformation::get_Initials. |
| set_Name(const System::String&) | Setter for Aspose::Words::Fields::UserInformation::get_Name. |
| static Type() | |
| UserInformation() |
Examples
Shows how to set user details, and display them using fields.
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
// Create a UserInformation object and set it as the data source for fields that display user information.
auto userInformation = MakeObject<UserInformation>();
userInformation->set_Name(u"John Doe");
userInformation->set_Initials(u"J. D.");
userInformation->set_Address(u"123 Main Street");
doc->get_FieldOptions()->set_CurrentUser(userInformation);
// Insert USERNAME, USERINITIALS, and USERADDRESS fields, which display values of
// the respective properties of the UserInformation object that we have created above.
ASSERT_EQ(userInformation->get_Name(), builder->InsertField(u" USERNAME ")->get_Result());
ASSERT_EQ(userInformation->get_Initials(), builder->InsertField(u" USERINITIALS ")->get_Result());
ASSERT_EQ(userInformation->get_Address(), builder->InsertField(u" USERADDRESS ")->get_Result());
// The field options object also has a static default user that fields from all documents can refer to.
UserInformation::get_DefaultUser()->set_Name(u"Default User");
UserInformation::get_DefaultUser()->set_Initials(u"D. U.");
UserInformation::get_DefaultUser()->set_Address(u"One Microsoft Way");
doc->get_FieldOptions()->set_CurrentUser(UserInformation::get_DefaultUser());
ASSERT_EQ(u"Default User", builder->InsertField(u" USERNAME ")->get_Result());
ASSERT_EQ(u"D. U.", builder->InsertField(u" USERINITIALS ")->get_Result());
ASSERT_EQ(u"One Microsoft Way", builder->InsertField(u" USERADDRESS ")->get_Result());
doc->UpdateFields();
doc->Save(ArtifactsDir + u"FieldOptions.CurrentUser.docx");
See Also
- Namespace Aspose::Words::Fields
- Library Aspose.Words for C++