GrapeCity.Documents.Word

GrapeCity.Documents.Word.SimpleField

Class SimpleField

Namespace: GrapeCity.Documents.Word

Assembly: GcDocs.Word.dll

Represents a simple field element in a body content.

public class SimpleField : ContentObject, IBrowsable<SimpleField>

Inheritance: object

ContentObject

SimpleField

Implements: IBrowsable<SimpleField>

Inherited Members: ContentObject.GetChildren<T>()

ContentObject.GetRange()

ContentObject.GetPersistentRange()

ContentObject.Delete()

ContentObject.CanAdd(Type)

ContentObject.CanAdd(Type, out Exception)

ContentObject.CanAddContentControl(ContentControlType)

ContentObject.CanAddContentControl(ContentControlType, out Exception)

ContentObject.ToString()

ContentObject.Start

ContentObject.End

ContentObject.ParentBody

ContentObject.ParentContent

ContentObject.Document

ContentObject.Children

ContentObject.Guid

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

Code

Gets or sets the field code.

public string Code { get; set; }

Property Value

string

CustomData

Gets or sets custom field data that is associated with this field. This property can be used as desired to store additional application-defined data with the field.

public string CustomData { get; set; }

Property Value

string

IsDirty

Gets or sets a value indicating whether this field has been flagged by an application to indicate that its current results are no longer correct (stale) due to other modifications made to the document, and these contents should be updated before they are displayed if this functionality is supported by the next processing application.

public bool IsDirty { get; set; }

Property Value

bool

Locked

Get or sets a value indicating whether this field shall not have its field result recalculated, even if an application attempts to recalculate the results of all fields in the document or a recalculation is explicitly requested.

public bool Locked { get; set; }

Property Value

bool

Gets the next simple field.

public SimpleField Next { get; }

Property Value

SimpleField

Gets the previous simple field.

public SimpleField Previous { get; }

Property Value

SimpleField

Methods

AddBidirectionalOverride()

Adds a BidirectionalOverride to the end of the current simple field.

public BidirectionalOverride AddBidirectionalOverride()

Returns

BidirectionalOverride: The added BidirectionalOverride.

AddBidirectionalOverride(BiDirection)

Adds a BidirectionalOverride to the end of the current simple field.

public BidirectionalOverride AddBidirectionalOverride(BiDirection direction)

Parameters

direction BiDirection: BidirectionalOverride direction value.

Returns

BidirectionalOverride: The added BidirectionalOverride.

AddComplexField(string, string)

Adds a ComplexField to the end of the current simple field.

public ComplexField AddComplexField(string code, string result)

Parameters

code string: The complex field code.
result string: The result text of the inserted field.

Returns

ComplexField: The added ComplexField.

AddComplexField(string)

Adds a ComplexField to the end of the current simple field.

public ComplexField AddComplexField(string code)

Parameters

code string: The complex field code.

Returns

ComplexField: The added ComplexField.

AddContentControl(ContentControlType, bool)

Adds a ContentControl to the end of the current simple field.

public ContentControl AddContentControl(ContentControlType type, bool fillContent = true)

Parameters

type ContentControlType: The new content control type.
fillContent bool: Whether to fill the new control content with default data.

Returns

ContentControl: The added ContentControl.

AddEndnote(string, char, string)

Adds an Endnote to the end of the current simple field.

public Endnote AddEndnote(string text, char referenceCharacter, string referenceFontName)

Parameters

text string: The endnote text.
referenceCharacter char: The endnote reference symbol.
referenceFontName string: The endnote reference symbol font.

Returns

Endnote: The added Endnote.

AddEndnote(string, string)

Adds an Endnote to the end of the current simple field.

public Endnote AddEndnote(string text, string reference)

Parameters

text string: The endnote text.
reference string: The endnote reference text.

Returns

Endnote: The added Endnote.

AddEndnote(string)

Adds an Endnote to the end of the current simple field.

public Endnote AddEndnote(string text = null)

Parameters

text string: The endnote text.

Returns

Endnote: The added Endnote.

AddFootnote(string, char, string)

Adds a Footnote to the end of the current simple field.

public Footnote AddFootnote(string text, char referenceCharacter, string referenceFontName)

Parameters

text string: The footnote text.
referenceCharacter char: The footnote reference symbol.
referenceFontName string: The footnote reference symbol font.

Returns

Footnote: The added Footnote.

AddFootnote(string, string)

Adds a Footnote to the end of the current simple field.

public Footnote AddFootnote(string text, string reference)

Parameters

text string: The footnote text.
reference string: The footnote reference text.

Returns

Footnote: The added Footnote.

AddFootnote(string)

Adds a Footnote to the end of the current simple field.

public Footnote AddFootnote(string text = null)

Parameters

text string: The footnote text.

Returns

Footnote: The added Footnote.

AddHyperlink()

Adds a Hyperlink to the end of the current simple field.

public Hyperlink AddHyperlink()

Returns

Hyperlink: The added Hyperlink.

AddHyperlink(string, string, string, string)

Adds a Hyperlink to the end of the current simple field.

public Hyperlink AddHyperlink(string anchor, string text, string screenTip = null, string target = null)

Parameters

anchor string: The name of a bookmark in the current document which shall be the target of this hyperlink.
text string: The display text of the specified hyperlink.
screenTip string: The text that appears as a ScreenTip when the mouse pointer is positioned over the specified hyperlink.
target string: The name of the frame or window in which you want to load the specified hyperlink.

Returns

Hyperlink: The added Hyperlink.

AddHyperlink(Uri, string, string, string, string)

Adds a Hyperlink to the end of the current simple field.

public Hyperlink AddHyperlink(Uri address, string anchor, string text, string screenTip = null, string target = null)

Parameters

address System.Uri: The address for the specified link. The address can be an e-mail address, an Internet address, or a file name.
anchor string: The name of a bookmark in the current document which shall be the target of this hyperlink.
text string: The display text of the specified hyperlink.
screenTip string: The text that appears as a ScreenTip when the mouse pointer is positioned over the specified hyperlink.
target string: The name of the frame or window in which you want to load the specified hyperlink.

Returns

Hyperlink: The added Hyperlink.

AddOMath()

Adds an OMath to the end of the current simple field.

public OMath AddOMath()

Returns

OMath: The added OMath.

AddOMath(OMathBuiltInEquation)

Adds an OMath to the end of the current simple field.

public OMath AddOMath(OMathBuiltInEquation equation)

Parameters

equation OMathBuiltInEquation: The built-in equation to fill the OMath.

Returns

OMath: The added OMath.

AddOMathParagraph()

Adds an OMathParagraph to the end of the current simple field.

public OMathParagraph AddOMathParagraph()

Returns

OMathParagraph: The added OMathParagraph.

AddOMathParagraph(OMathBuiltInEquation)

Adds an OMathParagraph to the end of the current simple field.

public OMathParagraph AddOMathParagraph(OMathBuiltInEquation equation)

Parameters

equation OMathBuiltInEquation: The built-in equation to fill the OMathParagraph.

Returns

OMathParagraph: The added OMathParagraph.

AddRun()

Adds a Run to the end of the current simple field.

public Run AddRun()

Returns

Run: The added Run.

AddRun(Style)

Adds a Run to the end of the current simple field.

public Run AddRun(Style style)

Parameters

style Style: The run character or linked paragraph style.

Returns

Run: The added Run.

AddRun(string, Style)

Adds a Run to the end of the current simple field.

public Run AddRun(string text, Style style)

Parameters

text string: The text of the run.
style Style: The run character or linked paragraph style.

Returns

Run: The added Run.

AddRun(string)

Adds a Run to the end of the current simple field.

public Run AddRun(string text)

Parameters

text string: The text of the run.

Returns

Run: The added Run.

AddSimpleField(string, string)

Adds a SimpleField to the end of the current simple field.

public SimpleField AddSimpleField(string code, string result)

Parameters

code string: The field code.
result string: The result text of the new field.

Returns

SimpleField: The added SimpleField.

AddSimpleField(string)

Adds a SimpleField to the end of the current simple field.

public SimpleField AddSimpleField(string code)

Parameters

code string: The field code.

Returns

SimpleField: The added SimpleField.