GrapeCity.Documents.Word

GrapeCity.Documents.Word.Paragraph

Class Paragraph

Namespace: GrapeCity.Documents.Word

Assembly: GcDocs.Word.dll

Represents a paragraph element in a body content.

public class Paragraph : FormattedContentObject, IBrowsable<Paragraph>

Inheritance: object

ContentObject

FormattedContentObject

Paragraph

Implements: IBrowsable<Paragraph>

Inherited Members: FormattedContentObject.GetInheritedFormatting()

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.OwnerSection

ContentObject.Document

ContentObject.Children

ContentObject.Guid

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

Format

Provides access to the paragraph formatting properties.

public ParagraphFormat Format { get; }

Property Value

ParagraphFormat

ListFormat

Gets the list formatting specified for the paragraph.

public ListFormat ListFormat { get; }

Property Value

ListFormat

Mark

Gets the set of properties applied to the glyph used to represent the physical location of the paragraph mark for this paragraph. This paragraph mark, being a physical character in the document, can be formatted, and therefore shall be capable of representing this formatting like any other character in the document.

public ParagraphMark Mark { get; }

Property Value

ParagraphMark

Gets the next paragraph.

public Paragraph Next { get; }

Property Value

Paragraph

Gets the previous paragraph.

public Paragraph Previous { get; }

Property Value

Paragraph

RevisionId

Gets unique identifiers used to track the paragraph editing session.

public ParagraphRevisionId RevisionId { get; }

Property Value

ParagraphRevisionId

Style

Gets or sets paragraph style that shall be used to format the contents of this paragraph.

public Style Style { get; set; }

Property Value

Style

Methods

AddBidirectionalOverride()

Adds a BidirectionalOverride to the end of the paragraph.

public BidirectionalOverride AddBidirectionalOverride()

Returns

BidirectionalOverride: The added BidirectionalOverride.

AddBidirectionalOverride(BiDirection)

Adds a BidirectionalOverride to the end of the paragraph.

public BidirectionalOverride AddBidirectionalOverride(BiDirection direction)

Parameters

direction BiDirection: BidirectionalOverride direction value.

Returns

BidirectionalOverride: The added BidirectionalOverride.

AddComplexField(IFieldOptions)

Adds a ComplexField to the end of the paragraph.

public ComplexField AddComplexField(IFieldOptions options)

Parameters

options IFieldOptions: The complex field options.

Returns

ComplexField: The added ComplexField.

AddComplexField(string)

Adds a ComplexField to the end of the paragraph.

public ComplexField AddComplexField(string code)

Parameters

code string: The complex field code.

Returns

ComplexField: The added ComplexField.

AddComplexField(string, string)

Adds a ComplexField to the end of the paragraph.

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.

AddContentControl(ContentControlType, bool)

Adds a ContentControl to the end of the paragraph.

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)

Adds an Endnote to the end of the paragraph.

public Endnote AddEndnote(string text = null)

Parameters

text string: The endnote text.

Returns

Endnote: The added Endnote.

AddEndnote(string, char, string)

Adds an Endnote to the end of the paragraph.

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 paragraph.

public Endnote AddEndnote(string text, string reference)

Parameters

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

Returns

Endnote: The added Endnote.

AddFootnote(string)

Adds a Footnote to the end of the paragraph.

public Footnote AddFootnote(string text = null)

Parameters

text string: The footnote text.

Returns

Footnote: The added Footnote.

AddFootnote(string, char, string)

Adds a Footnote to the end of the paragraph.

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 paragraph.

public Footnote AddFootnote(string text, string reference)

Parameters

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

Returns

Footnote: The added Footnote.

AddHyperlink()

Adds a Hyperlink to the end of the paragraph.

public Hyperlink AddHyperlink()

Returns

Hyperlink: The added Hyperlink.

AddHyperlink(string, string, string, string)

Adds a Hyperlink to the end of the paragraph.

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 paragraph.

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

Parameters

address 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 a OMath to the end of the paragraph.

public OMath AddOMath()

Returns

OMath: The added OMath.

AddOMath(OMathBuiltInEquation)

Adds a OMath to the end of the paragraph.

public OMath AddOMath(OMathBuiltInEquation equation)

Parameters

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

Returns

OMath: The added OMath.

AddOMathParagraph()

Adds a OMathParagraph to the end of the paragraph.

public OMathParagraph AddOMathParagraph()

Returns

OMathParagraph: The added OMathParagraph.

AddOMathParagraph(OMathBuiltInEquation)

Adds a OMathParagraph to the end of the paragraph.

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 paragraph.

public Run AddRun()

Returns

Run: The added Run.

AddRun(Style)

Adds a Run to the end of the paragraph.

public Run AddRun(Style style)

Parameters

style Style: The run character or linked paragraph style.

Returns

Run: The added Run.

AddRun(string)

Adds a Run to the end of the paragraph.

public Run AddRun(string text)

Parameters

text string: The text of the inserted Run

Returns

Run: The added Run.

AddRun(string, Style)

Adds a Run to the end of the paragraph.

public Run AddRun(string text, Style style)

Parameters

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

Returns

Run: The added Run.

AddSectionBreak(SectionStart)

Breaks the parent section right after this paragraph.

public Section AddSectionBreak(SectionStart sectionStart = SectionStart.NewPage)

Parameters

sectionStart SectionStart: The SectionStart for the new section.

Returns

Section: The newly created Section after this paragraph.

AddSimpleField(string)

Adds a SimpleField to the end of the paragraph.

public SimpleField AddSimpleField(string code)

Parameters

code string: The field code.

Returns

SimpleField: The added SimpleField.

AddSimpleField(string, string)

Adds a SimpleField to the end of the paragraph.

public SimpleField AddSimpleField(string code, string result)

Parameters

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

Returns

SimpleField: The added SimpleField.

RestartList(int?)

Restarts the list numbering on the current Paragraph.

The current paragraph must belong to a numbered list.

If startNumberingValue is omitted or null, numbering on the current list is restarted at the value of StartAt on the current level of the list template, otherwise a new list is created.

public void RestartList(int? startNumberingValue = null)

Parameters

startNumberingValue int?: Optional: the numbering start value.

Split(ContentObject, InsertLocation)

Splits the paragraph at a specified location relative to a specified child content.

public Paragraph Split(ContentObject child, InsertLocation location)

Parameters

child ContentObject: The child content where to split.
location InsertLocation: The position relative to child where to split.

Returns

Paragraph: The second part of the split paragraph content.