Paragraph Class |
Represents a paragraph of text.
Inheritance Hierarchy
System
Object
Spire.Doc OwnerHolder
Spire.Doc.Documents.XML DocumentSerializable
Spire.Doc DocumentObject
Spire.Doc DocumentBase
Spire.Doc BodyRegion
Spire.Doc.Documents Paragraph
Spire.Doc OwnerHolder
Spire.Doc.Documents.XML DocumentSerializable
Spire.Doc DocumentObject
Spire.Doc DocumentBase
Spire.Doc BodyRegion
Spire.Doc.Documents Paragraph
Namespace: Spire.Doc.Documents
Assembly: Spire.Doc (in Spire.Doc.dll) Version: 13.2.3.0 (13.2.3.3046)
Syntax
The Paragraph type exposes the following members.
Constructors
Properties
| Name | Description | |
|---|---|---|
|
BreakCharacterFormat |
Gets character format for the break symbol.
|
|
|
CharCount |
Gets the char count,whtout spaces.
|
|
|
CharCountIncludeSpace |
Gets the char count of the include spaces.
|
|
|
ChildObjects |
Gets the child objects.
(Overrides
DocumentObject
ChildObjects
.)
|
|
|
DeleteRevision |
Gets the delete revision for this objects.
Note this can be null. If null does not have delete revision.
(Inherited from
BodyRegion
.)
|
|
|
Document |
Gets the document.
(Inherited from
OwnerHolder
.)
|
|
|
DocumentObjectType |
Gets the type of the document object.
(Overrides
DocumentObject
DocumentObjectType
.)
|
|
|
FirstChild |
Gets the first child of the Element.
(Inherited from
DocumentObject
.)
|
|
|
Format |
Gets paragraph format.
|
|
|
Frame |
Gets frame format of the paragraph.
|
|
|
InsertRevision |
Gets the insert revision for this objects.
Note this can be null. If null does not have insert revision.
(Inherited from
BodyRegion
.)
|
|
|
IsComposite |
Indicating whether this instance is composite.
(Inherited from
DocumentObject
.)
|
|
|
IsDeleteRevision |
Gets a value indicating whether this item was deleted from the document.
(Inherited from
BodyRegion
.)
|
|
|
IsEndOfDocument |
Gets a value indicating whether this paragraph is end of document.
|
|
|
IsEndOfHeaderFooter |
True if this paragraph is the last paragraph in the
HeaderFooter
(main text story) of a
Section
; false otherwise.
|
|
|
IsEndOfSection |
Gets a value indicating whether this paragraph is end of section.
|
|
|
IsInCell |
Gets a value indicating whether this paragraph is in cell.
|
|
|
IsInsertRevision |
Gets a value indicating whether this item was inserted to the document.
(Inherited from
BodyRegion
.)
|
|
|
Item |
Gets paragraph item by index.
|
|
|
Items |
Gets paragraph items.
|
|
|
LastChild |
Gets the last child of the Element.
(Inherited from
DocumentObject
.)
|
|
|
ListFormat |
Gets list format of the paragraph.
|
|
|
ListText |
Gets the list text.
The value of the list number is obtained by dynamic calculation.
The value of the list number of the paragraph directly may be incorrect.
To obtain the correct value, you need to traverse all paragraphs in the document.
|
|
|
NextSibling |
Gets the next sibling.
(Inherited from
DocumentObject
.)
|
|
|
Owner |
Gets the owner of this entity.
(Inherited from
DocumentObject
.)
|
|
|
OwnerTextBody |
Gets the owner text body.
(Inherited from
BodyRegion
.)
|
|
|
ParentSection |
Gets the parent section of the current paragraph.
|
|
|
PreviousSibling |
Gets the previous sibling.
(Inherited from
DocumentObject
.)
|
|
|
StyleName |
Gets paragraph style name.
|
|
|
Text |
Returns or sets paragraph text.
|
|
|
WordCount |
Gets the word count.
|
|
XDLSHolder | (Inherited from DocumentSerializable .) |
Methods
| Name | Description | |
|---|---|---|
|
AppendBookmarkEnd |
Appends end of the bookmark with specified name into paragraph.
|
|
|
AppendBookmarkStart |
Appends start of the bookmark with specified name into paragraph.
|
|
|
AppendBreak |
Appends break to end of paragraph.
|
|
|
AppendChart(ChartType, Single, Single) |
Append an chart object into the document and scales it to the specified size.
|
|
|
AppendChart(ChartType, HorizontalOrigin, Single, VerticalOrigin, Single, Single, Single, TextWrappingStyle) |
Append an chart object into the document and scales it to the specified size.
|
|
|
AppendCheckBox |
Appends the check box form field.
|
|
|
AppendCheckBox(String, Boolean) |
Appends the check box.
|
|
|
AppendComment |
Appends the comment.
|
|
|
AppendCommentMark |
Appends the comment mark.
|
|
|
AppendDropDownFormField |
Appends the drop down form field.
|
|
|
AppendDropDownFormField(String) |
Appends the drop down form field.
|
|
|
AppendField |
Appends the field.
|
|
|
AppendFieldMark |
Appends the field mark.
|
|
|
AppendFootnote(FootnoteType) |
Appends the footnote.
|
|
|
AppendFootnote(FootnoteType, Boolean) |
Appends the footnote.
|
|
|
AppendHorizonalLine |
Append Horizonal Line to the end of the paragraph.
|
|
|
AppendHTML |
Appends the HTML.
|
|
|
AppendHyperlink(String, DocPicture, HyperlinkType) |
Appends the hyperlink.
|
|
|
AppendHyperlink(String, String, HyperlinkType) |
Appends the hyperlink.
|
|
|
AppendOleObject(String, DocPicture) |
Appends the OLE object.
|
|
|
AppendOleObject( Byte , DocPicture, OleLinkType) |
Appends the OLE object.
|
|
|
AppendOleObject( Byte , DocPicture, OleObjectType) |
Appends the OLE object into paragraph.
|
|
|
AppendOleObject( Byte , DocPicture, String) |
Appends the package OLE object (ole object without specified type).
|
|
|
AppendOleObject(Stream, DocPicture, OleLinkType) |
Appends the OLE object into paragraph.
|
|
|
AppendOleObject(Stream, DocPicture, OleObjectType) |
Appends the OLE object.
|
|
|
AppendOleObject(Stream, DocPicture, String) |
Appends the package OLE object (ole object without specified type).
|
|
|
AppendOleObject(String, DocPicture, OleLinkType) |
Appends the OLE object.
|
|
|
AppendOleObject(String, DocPicture, OleObjectType) |
Appends the OLE object into paragraph.
|
|
|
AppendOleObject(String, String, Byte , DocPicture) |
Appends the OLE object into paragraph.
|
|
|
AppendPermEnd |
Appends end of the permission with specified id into paragraph.
|
|
|
AppendPermStart |
Appends start of the permission with specified id into paragraph.
|
|
|
AppendPicture( Byte ) |
Appends image to end of paragraph.
|
|
|
AppendPicture(Image) |
Appends a picture to the document.
|
|
|
AppendPicture(Stream) |
Appends the picture.
|
|
|
AppendPicture(String) |
Appends the picture.
|
|
|
AppendRTF(String) |
Appends the RTF.
|
|
|
AppendRTF(String, Boolean) |
Appends the RTF.
|
|
|
AppendShape |
Append Shape to the end of the paragraph.
|
|
|
AppendShapeGroup |
Append shape Group to the end of the paragraph.
|
|
|
AppendSymbol |
Appends special symbol to end of paragraph.
|
|
|
AppendText |
Appends text to end of document.
|
|
|
AppendTextBox |
Append Textbox to the end of the paragraph
|
|
|
AppendTextFormField(String) |
Appends the text form field.
|
|
|
AppendTextFormField(String, String) |
Appends the text form field.
|
|
|
AppendTOC |
Appends the table of content.
|
|
|
ApplyStyle(String) |
Applies the specified style.
|
|
|
ApplyStyle(BuiltinStyle) |
Applies the built-in style.
|
|
|
ApplyStyle(IParagraphStyle) |
Applies the specified style.
|
|
|
Clone |
Creates a duplicate of the document object.
(Inherited from
DocumentObject
.)
|
|
CloneImpl | (Overrides DocumentSerializable CloneImpl .) |
|
|
CreateLayoutInfo | (Overrides DocumentBase CreateLayoutInfo .) |
|
|
Equals |
Determines whether the specified object is equal to the current object.
(Inherited from
Object
.)
|
|
|
Finalize |
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from
Object
.)
|
|
|
Find(Regex) |
Returns first entry of matchString regex.
(Overrides
BodyRegion
Find(Regex)
.)
|
|
|
Find(String, Boolean, Boolean) |
Returns first entry of matchString string, taking into consideration caseSensitive
and wholeWord options.
|
|
|
FindAllPattern |
Finds all occurrences of the specified regex pattern in the text and returns them as an array of TextSelection.
|
|
|
FindAllString |
Finds all occurrences of a specified string within the text, with options for case sensitivity and whole word matching.
|
|
|
GetHashCode |
Serves as the default hash function.
(Inherited from
Object
.)
|
|
|
GetIndex |
Returns the zero-based index of the specified entity.
|
|
|
GetListFormatForApplyStyle |
Gets the list format for apply style.
|
|
|
GetNextInSection | (Inherited from BodyRegion .) |
|
|
GetNextWidgetSibling |
Gets the next sibling.
(Inherited from
DocumentObject
.)
|
|
|
GetPreviousWidgetSibling |
Gets the previous widget sibling.
(Inherited from
DocumentObject
.)
|
|
|
GetStyle |
Gets related style.
|
|
|
GetType |
Gets the
Type
of the current instance.
(Inherited from
Object
.)
|
|
|
InitXDLSHolder | (Overrides DocumentSerializable InitXDLSHolder .) |
|
|
InsertSectionBreak |
Inserts the section break.
|
|
|
InsertSectionBreak(SectionBreakType) |
Inserts the section break.
|
|
|
MemberwiseClone |
Creates a shallow copy of the current
Object
.
(Inherited from
Object
.)
|
|
|
ReadXmlAttributes | (Inherited from DocumentSerializable .) |
|
|
ReadXmlContent | (Inherited from DocumentSerializable .) |
|
|
RemoveAbsPosition | |
|
|
RemoveFrame |
Remove a frame.
|
|
|
Replace(Regex, TextSelection) | (Overrides BodyRegion Replace(Regex, TextSelection) .) |
|
|
Replace(Regex, String) | (Overrides BodyRegion Replace(Regex, String) .) |
|
|
Replace(Regex, TextSelection, Boolean) | (Overrides BodyRegion Replace(Regex, TextSelection, Boolean) .) |
|
|
Replace(String, TextSelection, Boolean, Boolean) | |
|
|
Replace(String, String, Boolean, Boolean) | (Overrides BodyRegion Replace(String, String, Boolean, Boolean) .) |
|
|
Replace(String, TextSelection, Boolean, Boolean, Boolean) | |
|
|
RestoreReference | (Overrides DocumentSerializable RestoreReference(String, Int32) .) |
|
|
ToString |
Returns a string that represents the current object.
(Inherited from
Object
.)
|
|
|
ToString(String) |
Exports the name and index in container of the object into a string in the specified seperator.
(Inherited from
DocumentObject
.)
|
|
|
UpdateListValue |
Updates the list value.
The value of the list number is obtained by dynamic calculation.
The value of the list number of the paragraph directly may be incorrect.
To obtain the correct value, you need to traverse all paragraphs in the document.
|
|
|
UpdateWordCount |
Calculate word count and character count of the paragraph.
|
|
|
WriteXmlAttributes | (Overrides DocumentSerializable WriteXmlAttributes(IXDLSAttributeWriter) .) |
|
|
WriteXmlContent | (Inherited from DocumentSerializable .) |
Fields
| Name | Description | |
|---|---|---|
|
m_doc | (Inherited from OwnerHolder .) |
|
|
m_pItemColl | |
|
|
m_style |
See Also
