FieldAuthor Class

Implements the AUTHOR field.

Inheritance Hierarchy

SystemObject
Aspose.Words.FieldsField
Aspose.Words.FieldsFieldAuthor

Namespace: Aspose.Words.Fields
Assembly: Aspose.Words (in Aspose.Words.dll) Version: 20.3

Syntax

C++

public class FieldAuthor : Field

Public Class FieldAuthor
	Inherits Field

public ref class FieldAuthor : public Field

type FieldAuthor =  
    class
        inherit Field
    end

The FieldAuthor type exposes the following members.

Constructors

	Name	Description
	FieldAuthor	Initializes a new instance of the FieldAuthor class

Properties

	Name	Description
	AuthorName	Gets or sets the document author's name.
	DisplayResult	Gets the text that represents the displayed field result. (Inherited from Field.)
	End	Gets the node that represents the field end. (Inherited from Field.)
	Format	Gets a FieldFormat object that provides typed access to field's formatting. (Inherited from Field.)
	IsDirty	Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. (Inherited from Field.)
	IsLocked	Gets or sets whether the field is locked (should not recalculate its result). (Inherited from Field.)
	LocaleId	Gets or sets the LCID of the field. (Inherited from Field.)
	Result	Gets or sets text that is between the field separator and field end. (Inherited from Field.)
	Separator	Gets the node that represents the field separator. Can be null. (Inherited from Field.)
	Start	Gets the node that represents the start of the field. (Inherited from Field.)
	Type	Gets the Microsoft Word field type. (Inherited from Field.)

Methods

	Name	Description
	Equals	(Inherited from Object.)
	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. (Inherited from Field.)
	GetFieldCode(Boolean)	Returns text between field start and field separator (or field end if there is no separator). (Inherited from Field.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	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. (Inherited from Field.)
	ToString	(Inherited from Object.)
	Unlink	Performs the field unlink. (Inherited from Field.)
	Update	Performs the field update. Throws if the field is being updated already. (Inherited from Field.)
	Update(Boolean)	Performs a field update. Throws if the field is being updated already. (Inherited from Field.)

Remarks

Retrieves, and optionally sets, the document author's name, as recorded in the Author property of the built-in document properties.

Examples

Shows how to display a document creator's name with an AUTHOR field.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// If we open an existing document, the document's author's full name will be displayed by the field
// If we create a document programmatically, we need to set this attribute to the author's name so our field has something to display
doc.FieldOptions.DefaultDocumentAuthor = "Joe Bloggs";

builder.Write("This document was created by ");
FieldAuthor field = (FieldAuthor)builder.InsertField(FieldType.FieldAuthor, true);
field.Update();

Assert.AreEqual(" AUTHOR ", field.GetFieldCode());
Assert.AreEqual("Joe Bloggs", field.Result);

// If this property has a value, it will supersede the one we set above 
doc.BuiltInDocumentProperties.Author = "John Doe";      
field.Update();

Assert.AreEqual(" AUTHOR ", field.GetFieldCode());
Assert.AreEqual("John Doe", field.Result);

// Our field can also override the document's built in author name like this
field.AuthorName = "Jane Doe";
field.Update();

Assert.AreEqual(" AUTHOR  \"Jane Doe\"", field.GetFieldCode());
Assert.AreEqual("Jane Doe", field.Result);

// The author name in the built in properties was changed by the field, but the default document author stays the same
Assert.AreEqual("Jane Doe", doc.BuiltInDocumentProperties.Author);
Assert.AreEqual("Joe Bloggs", doc.FieldOptions.DefaultDocumentAuthor);

doc.Save(ArtifactsDir + "Field.AUTHOR.docx");

Reference

Aspose.Words.Fields Namespace