FieldUserInitials
Contents
[
Hide
]FieldUserInitials class
Implements the USERINITIALS field.
To learn more, visit the Working with Fields documentation article.
public class FieldUserInitials : Field
Constructors
| Name | Description |
|---|---|
| FieldUserInitials() | The default constructor. |
Properties
| Name | Description |
|---|---|
| DisplayResult { get; } | Gets the text that represents the displayed field result. |
| End { get; } | Gets the node that represents the field end. |
| Format { get; } | Gets a FieldFormat object that provides typed access to field’s formatting. |
| IsDirty { get; set; } | Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. |
| IsLocked { get; set; } | Gets or sets whether the field is locked (should not recalculate its result). |
| LocaleId { get; set; } | Gets or sets the LCID of the field. |
| Result { get; set; } | Gets or sets text that is between the field separator and field end. |
| Separator { get; } | Gets the node that represents the field separator. Can be null. |
| Start { get; } | Gets the node that represents the start of the field. |
| virtual Type { get; } | Gets the Microsoft Word field type. |
| UserInitials { get; set; } | Gets or sets the current user’s initials. |
Methods
| Name | Description |
|---|---|
| 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. |
| GetFieldCode(bool) | Returns text between field start and field separator (or field end if there is no separator). |
| virtual 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. |
| Unlink() | Performs the field unlink. |
| Update() | Performs the field update. Throws if the field is being updated already. |
| Update(bool) | Performs a field update. Throws if the field is being updated already. |
Remarks
Retrieves the current user’s initials.
Examples
Shows how to use the USERINITIALS field.
Document doc = new Document();
// Create a UserInformation object and set it as the source of user information for any fields that we create.
UserInformation userInformation = new UserInformation();
userInformation.Initials = "J. D.";
doc.FieldOptions.CurrentUser = userInformation;
// Create a USERINITIALS field to display the current user's initials,
// taken from the UserInformation object we created above.
DocumentBuilder builder = new DocumentBuilder(doc);
FieldUserInitials fieldUserInitials = (FieldUserInitials)builder.InsertField(FieldType.FieldUserInitials, true);
Assert.That(fieldUserInitials.Result, Is.EqualTo(userInformation.Initials));
Assert.That(fieldUserInitials.GetFieldCode(), Is.EqualTo(" USERINITIALS "));
Assert.That(fieldUserInitials.Result, Is.EqualTo("J. D."));
// We can set this property to get our field to override the value currently stored in the UserInformation object.
fieldUserInitials.UserInitials = "J. C.";
fieldUserInitials.Update();
Assert.That(fieldUserInitials.GetFieldCode(), Is.EqualTo(" USERINITIALS \"J. C.\""));
Assert.That(fieldUserInitials.Result, Is.EqualTo("J. C."));
// This does not affect the value in the UserInformation object.
Assert.That(doc.FieldOptions.CurrentUser.Initials, Is.EqualTo("J. D."));
doc.UpdateFields();
doc.Save(ArtifactsDir + "Field.USERINITIALS.docx");
See Also
- class Field
- namespace Aspose.Words.Fields
- assembly Aspose.Words
