FieldStyleRef Class

Implements the STYLEREF field.

Inheritance Hierarchy

SystemObject
Aspose.Words.FieldsField
Aspose.Words.FieldsFieldStyleRef

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

Syntax

C++

public class FieldStyleRef : Field

Public Class FieldStyleRef
	Inherits Field

public ref class FieldStyleRef : public Field

type FieldStyleRef =  
    class
        inherit Field
    end

The FieldStyleRef type exposes the following members.

Constructors

	Name	Description
	FieldStyleRef	Initializes a new instance of the FieldStyleRef 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.)
	InsertParagraphNumber	Gets or sets whether to insert the paragraph number of the referenced paragraph exactly as it appears in the document.
	InsertParagraphNumberInFullContext	Gets or sets whether to insert the paragraph number of the referenced paragraph in full context.
	InsertParagraphNumberInRelativeContext	Gets or sets whether to insert the paragraph number of the referenced paragraph in relative context.
	InsertRelativePosition	Gets or sets whether to insert the relative position of the referenced paragraph.
	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.)
	SearchFromBottom	Gets or sets whether to search from the bottom of the current page, rather from the top.
	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.)
	StyleName	Gets or sets the name of the style by which the text to search for is formatted.
	SuppressNonDelimiters	Gets or sets whether to suppress non-delimiter characters.
	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

The STYLEREF is used to reference a fragment of text within the document that is formatted with the specified style.

Examples

Shows how to use STYLEREF fields.

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

// Create a list based on one of the Microsoft Word list templates
Aspose.Words.Lists.List list = doc.Lists.Add(Aspose.Words.Lists.ListTemplate.NumberDefault);

// This generated list will look like "1.a )"
// The space before the bracket is a non-delimiter character that can be suppressed
list.ListLevels[0].NumberFormat = "\x0000.";
list.ListLevels[1].NumberFormat = "\x0001 )";

// Add text and apply paragraph styles that will be referenced by STYLEREF fields
builder.ListFormat.List = list;
builder.ListFormat.ListIndent();
builder.ParagraphFormat.Style = doc.Styles["List Paragraph"];
builder.Writeln("Item 1");
builder.ParagraphFormat.Style = doc.Styles["Quote"];
builder.Writeln("Item 2");
builder.ParagraphFormat.Style = doc.Styles["List Paragraph"];
builder.Writeln("Item 3");
builder.ListFormat.RemoveNumbers();
builder.ParagraphFormat.Style = doc.Styles["Normal"];

// Place a STYLEREF field in the header and have it display the first "List Paragraph"-styled text in the document
builder.MoveToHeaderFooter(HeaderFooterType.HeaderPrimary);
FieldStyleRef fieldStyleRef = (FieldStyleRef)builder.InsertField(FieldType.FieldStyleRef, true);
fieldStyleRef.StyleName = "List Paragraph";

// Place a STYLEREF field in the footer and have it display the last text
builder.MoveToHeaderFooter(HeaderFooterType.FooterPrimary);
fieldStyleRef = (FieldStyleRef)builder.InsertField(FieldType.FieldStyleRef, true);
fieldStyleRef.StyleName = "List Paragraph";
fieldStyleRef.SearchFromBottom = true;

builder.MoveToDocumentEnd();

// We can also use STYLEREF fields to reference the list numbers of lists
builder.Write("\nParagraph number: ");
fieldStyleRef = (FieldStyleRef)builder.InsertField(FieldType.FieldStyleRef, true);
fieldStyleRef.StyleName = "Quote";
fieldStyleRef.InsertParagraphNumber = true;

builder.Write("\nParagraph number, relative context: ");
fieldStyleRef = (FieldStyleRef)builder.InsertField(FieldType.FieldStyleRef, true);
fieldStyleRef.StyleName = "Quote";
fieldStyleRef.InsertParagraphNumberInRelativeContext = true;

builder.Write("\nParagraph number, full context: ");
fieldStyleRef = (FieldStyleRef)builder.InsertField(FieldType.FieldStyleRef, true);
fieldStyleRef.StyleName = "Quote";
fieldStyleRef.InsertParagraphNumberInFullContext = true;

builder.Write("\nParagraph number, full context, non-delimiter chars suppressed: ");
fieldStyleRef = (FieldStyleRef)builder.InsertField(FieldType.FieldStyleRef, true);
fieldStyleRef.StyleName = "Quote";
fieldStyleRef.InsertParagraphNumberInFullContext = true;
fieldStyleRef.SuppressNonDelimiters = true;

doc.UpdateFields();
doc.Save(ArtifactsDir + "Field.STYLEREF.docx");

Reference

Aspose.Words.Fields Namespace