FieldShape Class

Implements the SHAPE field.

Inheritance Hierarchy

SystemObject
Aspose.Words.FieldsField
Aspose.Words.FieldsFieldShape

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

Syntax

C++

public class FieldShape : Field

Public Class FieldShape
	Inherits Field

public ref class FieldShape : public Field

type FieldShape =  
    class
        inherit Field
    end

The FieldShape type exposes the following members.

Constructors

	Name	Description
	FieldShape	Initializes a new instance of the FieldShape 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 to retrieve.
	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 the specified text.

Examples

Shows how to create RTL lists with BIDIOUTLINE fields.

// Create a blank document and a document builder
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Use our builder to insert a BIDIOUTLINE field
// This field numbers paragraphs like the AUTONUM/LISTNUM fields,
// but is only visible when a RTL editing language is enabled, such as Hebrew or Arabic
// The following field will display ".1", the RTL equivalent of list number "1."
FieldBidiOutline field = (FieldBidiOutline)builder.InsertField(FieldType.FieldBidiOutline, true);
Assert.AreEqual(" BIDIOUTLINE ", field.GetFieldCode());
builder.Writeln("שלום");

// Add two more BIDIOUTLINE fields, which will be automatically numbered ".2" and ".3"
builder.InsertField(FieldType.FieldBidiOutline, true);
builder.Writeln("שלום");
builder.InsertField(FieldType.FieldBidiOutline, true);
builder.Writeln("שלום");

// Set the horizontal text alignment for every paragraph in the document to RTL
foreach (Paragraph para in doc.GetChildNodes(NodeType.Paragraph, true))
{
    para.ParagraphFormat.Bidi = true;
}

// If a RTL editing language is enabled in Microsoft Word, out fields will display numbers
// Otherwise, they will appear as "###" 
doc.Save(ArtifactsDir + "Field.BIDIOUTLINE.docx");

Examples

Shows how some older Microsoft Word fields such as SHAPE and EMBED are handled.

// Open a document that was created in Microsoft Word 2003
Document doc = new Document(MyDir + "Legacy fields.doc");

// If we open the document in Word and press Alt+F9, we will see a SHAPE and an EMBED field
// A SHAPE field is the anchor/canvas for an autoshape object with the "In line with text" wrapping style enabled
// An EMBED field has the same function, but for an embedded object, such as a spreadsheet from an external Excel document
// However, these fields will not appear in the document's Fields collection
Assert.AreEqual(0, doc.Range.Fields.Count);

// These fields are supported only by old versions of Microsoft Word
// As such, they are converted into shapes during the document importation process and can instead be found in the collection of Shape nodes
NodeCollection shapes = doc.GetChildNodes(NodeType.Shape, true);
Assert.AreEqual(3, shapes.Count);

// The first Shape node corresponds to what was the SHAPE field in the input document: the inline canvas for an autoshape
Shape shape = (Shape)shapes[0];
Assert.AreEqual(ShapeType.Image, shape.ShapeType);

// The next Shape node is the autoshape that is within the canvas
shape = (Shape)shapes[1];
Assert.AreEqual(ShapeType.Can, shape.ShapeType);

// The third Shape is what was the EMBED field that contained the external spreadsheet
shape = (Shape)shapes[2];
Assert.AreEqual(ShapeType.OleObject, shape.ShapeType);

Reference

Aspose.Words.Fields Namespace