FieldSubject Class

Implements the SUBJECT field.

Inheritance Hierarchy

SystemObject
Aspose.Words.FieldsField
Aspose.Words.FieldsFieldSubject

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

Syntax

C++

public class FieldSubject : Field

Public Class FieldSubject
	Inherits Field

public ref class FieldSubject : public Field

type FieldSubject =  
    class
        inherit Field
    end

The FieldSubject type exposes the following members.

Constructors

	Name	Description
	FieldSubject	Initializes a new instance of the FieldSubject class

Properties

	Name	Description
	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.)
	Text	Gets or sets the text of the subject.
	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's subject, as recorded in the Subject property of the built-in document properties.

Examples

Shows how to use the SUBJECT field.

Document doc = new Document();

// Set a value for the document's subject property
doc.BuiltInDocumentProperties.Subject = "My subject";

// We can display this value with a SUBJECT field
DocumentBuilder builder = new DocumentBuilder(doc);
FieldSubject field = (FieldSubject)builder.InsertField(FieldType.FieldSubject, true);
field.Update();

Assert.AreEqual(" SUBJECT ", field.GetFieldCode());
Assert.AreEqual("My subject", field.Result);

// We can also set the field's Text attribute to override the current value of the Subject property
field.Text = "My new subject";
field.Update();

Assert.AreEqual(" SUBJECT  \"My new subject\"", field.GetFieldCode());
Assert.AreEqual("My new subject", field.Result);

// As well as displaying a new value in our field, we also changed the value of the document property
Assert.AreEqual("My new subject", doc.BuiltInDocumentProperties.Subject);

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

Reference

Aspose.Words.Fields Namespace