Interface IParagraph

Interface publishes paragraph functionality

Inherited Members
Namespace: Syncfusion.DLS
Assembly: Syncfusion.DLS.Base.dll
Syntax
public interface IParagraph : IEntityBase, IStyleHolder

Properties

CharacterFormat

Gets character format.

Declaration
CharacterFormat CharacterFormat { get; }
Property Value
Type
CharacterFormat

Item[Int32]

Gets paragraph item.

Declaration
IParagraphItem this[int index] { get; }
Parameters
Type Name Description
System.Int32 index
Property Value
Type
IParagraphItem

ItemsCount

Gets items count.

Declaration
int ItemsCount { get; }
Property Value
Type
System.Int32

ListFormat

Gets list formatting for the paragraph.

Declaration
ListFormat ListFormat { get; }
Property Value
Type
ListFormat

ParagraphFormat

Gets paragraph format.

Declaration
ParagraphFormat ParagraphFormat { get; }
Property Value
Type
ParagraphFormat

Text

Gets / sets paragraph text.

Declaration
string Text { get; set; }
Property Value
Type
System.String

Methods

AppendBookmarkEnd(String)

Appends end of the bookmark with specified name into paragraph.

Declaration
BookmarkEnd AppendBookmarkEnd(string name)
Parameters
Type Name Description
System.String name
Returns
Type
BookmarkEnd

AppendBookmarkStart(String)

Appends start of the bookmark with specified name into paragraph.

Declaration
BookmarkStart AppendBookmarkStart(string name)
Parameters
Type Name Description
System.String name
Returns
Type
BookmarkStart

AppendCanvas(SizeF)

Appends canvas to end of paragraph.

Declaration
ICanvas AppendCanvas(SizeF size)
Parameters
Type Name Description
System.Drawing.SizeF size

Size of the canvas.
Returns
Type
ICanvas

AppendField(DLSFieldType)

Append field to end of the paragraph.

Declaration
IField AppendField(DLSFieldType type)
Parameters
Type Name Description
DLSFieldType type
Returns
Type
IField

AppendPicture(Image)

Appends picture to end of paragraph.

Declaration
IPicture AppendPicture(Image image)
Parameters
Type Name Description
System.Drawing.Image image
Returns
Type
IPicture

AppendTable()

Appends table to end of paragraph.

Declaration
ITable AppendTable()
Returns
Type
ITable

AppendText(String)

Appends text to end of paragraph.

Declaration
ITextRange AppendText(string text)
Parameters
Type Name Description
System.String text
Returns
Type
ITextRange

AppendTextBox(Single, Single)

Append Textbox to the end of the paragraph

Declaration
ITextBox AppendTextBox(float width, float height)
Parameters
Type Name Description
System.Single width

Textbox width
System.Single height

Textbox height
Returns
Type
ITextBox

Clone(IDocument)

Clones itself and sets new owner document.

Declaration
IParagraph Clone(IDocument doc)
Parameters
Type Name Description
IDocument doc
Returns
Type
IParagraph

GetStyle()

Gets related style.

Declaration
IParagraphStyle GetStyle()
Returns
Type
IParagraphStyle

IndexOfItem(IParagraphItem)

Gets index of specified paragraph item.

Declaration
int IndexOfItem(IParagraphItem item)
Parameters
Type Name Description
IParagraphItem item
Returns
Type
System.Int32

InsertItem(Int32, IParagraphItem)

Inserts paragraph item to specified position.

Declaration
void InsertItem(int index, IParagraphItem pItem)
Parameters
Type Name Description
System.Int32 index
IParagraphItem pItem

RemoveItem(IParagraphItem)

Removes specified paragraph item.

Declaration
void RemoveItem(IParagraphItem item)
Parameters
Type Name Description
IParagraphItem item

RemoveItemAt(Int32)

Removes paragraph item at specified position.

Declaration
void RemoveItemAt(int index)
Parameters
Type Name Description
System.Int32 index

Replace(String, TextRangesHolder, Boolean, Boolean)

Replaces all entries of given string with TextRangesHolder, taking into consideration caseSensitive and wholeWord options.

Declaration
void Replace(string given, TextRangesHolder rangesHolder, bool caseSensitive, bool wholeWord)
Parameters
Type Name Description
System.String given
TextRangesHolder rangesHolder
System.Boolean caseSensitive
System.Boolean wholeWord

Replace(String, String, Boolean, Boolean)

Replaces all entries of given string with replace string, taking into consideration caseSensitive and wholeWord options.

Declaration
int Replace(string given, string replace, bool caseSensitive, bool wholeWord)
Parameters
Type Name Description
System.String given
System.String replace
System.Boolean caseSensitive
System.Boolean wholeWord
Returns
Type
System.Int32

Replace(Regex, TextRangesHolder)

Replaces all entries of given regular expression with TextRangesHolder.

Declaration
void Replace(Regex pattern, TextRangesHolder rangesHolder)
Parameters
Type Name Description
System.Text.RegularExpressions.Regex pattern
TextRangesHolder rangesHolder

Replace(Regex, String)

Replaces all entries of given regular expression with replace string.

Declaration
int Replace(Regex pattern, string replace)
Parameters
Type Name Description
System.Text.RegularExpressions.Regex pattern
System.String replace
Returns
Type
System.Int32