Class Paragraph
Inheritance
System.Object
Paragraph
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Assembly: Syncfusion.DLS.Base.dll
Syntax
public class Paragraph : WidgetContainer, IXDLSSerializable, IWidgetContainer, IWidget, IParagraph, IEntityBase, IStyleHolder
Constructors
Paragraph(IDocument)
Declaration
public Paragraph(IDocument doc)
Parameters
Paragraph(IParagraph, IDocument)
Declaration
protected Paragraph(IParagraph paragraph, IDocument doc)
Parameters
Fields
Declaration
protected CharacterFormat m_chFormat
Field Value
Declaration
protected ListFormat m_listFormat
Field Value
m_pItemColl
Declaration
protected IParagraphItemCollection m_pItemColl
Field Value
Declaration
protected ParagraphFormat m_prFormat
Field Value
m_style
Declaration
protected IParagraphStyle m_style
Field Value
Properties
Declaration
public CharacterFormat CharacterFormat { get; }
Property Value
Item[Int32]
Gets paragraph item by index.
Declaration
public IParagraphItem this[int index] { get; }
Parameters
Type |
Name |
Description |
System.Int32 |
index |
|
Property Value
Items
Gets Items of the paragraph.
Declaration
protected IParagraphItemCollection Items { get; }
Property Value
ItemsCount
Gets paragraph items count.
Declaration
public int ItemsCount { get; }
Property Value
Gets format of the list for the paragraph.
Declaration
public ListFormat ListFormat { get; }
Property Value
Declaration
public ParagraphFormat ParagraphFormat { get; }
Property Value
StyleName
Gets paragraph style name.
Declaration
public string StyleName { get; }
Property Value
Text
Gets / sets paragraph text.
Declaration
public string Text { get; set; }
Property Value
Declaration
protected override ICollectionBase WidgetCollection { get; }
Property Value
Overrides
Methods
AppendBookmarkEnd(String)
Appends end of the bookmark with specified name into paragraph.
Declaration
public BookmarkEnd AppendBookmarkEnd(string name)
Parameters
Type |
Name |
Description |
System.String |
name |
|
Returns
AppendBookmarkStart(String)
Appends start of the bookmark with specified name into paragraph.
Declaration
public BookmarkStart AppendBookmarkStart(string name)
Parameters
Type |
Name |
Description |
System.String |
name |
|
Returns
AppendCanvas(SizeF)
Append canvas to end of paragraph.
Declaration
public virtual ICanvas AppendCanvas(SizeF size)
Parameters
Type |
Name |
Description |
System.Drawing.SizeF |
size |
|
Returns
AppendField(DLSFieldType)
Appends field to end of paragraph.
Declaration
public IField AppendField(DLSFieldType type)
Parameters
Returns
AppendParagraphItem(ParagraphItemType)
Appends paragraph item to the end of paragraph.
Declaration
protected virtual IParagraphItem AppendParagraphItem(ParagraphItemType itemType)
Parameters
Returns
AppendPicture(Byte[])
Declaration
public IPicture AppendPicture(byte[] imageBytes)
Parameters
Type |
Name |
Description |
System.Byte[] |
imageBytes |
|
Returns
AppendPicture(Image)
Appends image to end of paragraph.
Declaration
public IPicture AppendPicture(Image image)
Parameters
Type |
Name |
Description |
System.Drawing.Image |
image |
|
Returns
AppendTable()
Append table to end of paragraph.
Declaration
public ITable AppendTable()
Returns
AppendText(String)
Appends text to end of document.
Declaration
public ITextRange AppendText(string text)
Parameters
Type |
Name |
Description |
System.String |
text |
|
Returns
AppendTextBox(Single, Single)
Append Textbox to the end of the paragraph
Declaration
public ITextBox AppendTextBox(float width, float height)
Parameters
Type |
Name |
Description |
System.Single |
width |
|
System.Single |
height |
|
Returns
Declaration
protected void ApplyBaseStyleFormats()
ApplyStyle(String)
Applies the specified style.
Declaration
public void ApplyStyle(string styleName)
Parameters
Type |
Name |
Description |
System.String |
styleName |
Style name
|
Clone(IDocument)
Declaration
public IParagraph Clone(IDocument doc)
Parameters
Returns
CloneImpl(IDocument)
Clone method implementation.
Declaration
protected virtual IParagraph CloneImpl(IDocument doc)
Parameters
Returns
CloneParaLstOverrideStyles(IDocument, IDocument)
Clones the paragraph's list override styles.
Declaration
protected virtual void CloneParaLstOverrideStyles(IDocument sourceDocument, IDocument destDocument)
Parameters
CreateLayoutInfo()
Declaration
protected override void CreateLayoutInfo()
Overrides
Find(String, Boolean, Boolean)
Returns first entry of given string, taking into consideration caseSensitive
and wholeWord options.
Declaration
public TextRangesHolder Find(string given, bool caseSensitive, bool wholeWord)
Parameters
Type |
Name |
Description |
System.String |
given |
|
System.Boolean |
caseSensitive |
|
System.Boolean |
wholeWord |
|
Returns
Find(Regex)
Returns first entry of given regex.
Declaration
public TextRangesHolder Find(Regex pattern)
Parameters
Type |
Name |
Description |
System.Text.RegularExpressions.Regex |
pattern |
|
Returns
GetStyle()
Declaration
public IParagraphStyle GetStyle()
Returns
GetText(Int32, Int32)
Declaration
protected string GetText(int startIndex, int length)
Parameters
Type |
Name |
Description |
System.Int32 |
startIndex |
|
System.Int32 |
length |
|
Returns
IndexOfItem(IParagraphItem)
Gets index of specified paragraph item.
Declaration
public int IndexOfItem(IParagraphItem item)
Parameters
Returns
InitXDLSHolder()
Registers paragraph elements for xml serialization
Declaration
protected override void InitXDLSHolder()
Overrides
InsertItem(Int32, IParagraphItem)
Inserts paragraph item to specified position.
Declaration
public void InsertItem(int index, IParagraphItem pItem)
Parameters
RemoveItem(IParagraphItem)
Removes specified paragraph item.
Declaration
public void RemoveItem(IParagraphItem item)
Parameters
RemoveItemAt(Int32)
Removes paragraph item at specified position.
Declaration
public void RemoveItemAt(int index)
Parameters
Type |
Name |
Description |
System.Int32 |
index |
|
Replaces all entries of given string with TextRangesHolder, taking into
consideration caseSensitive and wholeWord options.
Declaration
public 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
public 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
Replaces all entries of given regular expression with TextRangesHolder.
Declaration
public 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
public int Replace(Regex pattern, string replace)
Parameters
Type |
Name |
Description |
System.Text.RegularExpressions.Regex |
pattern |
|
System.String |
replace |
|
Returns
ReplaceWithoutCorrection(Int32, Int32, String)
Declaration
protected void ReplaceWithoutCorrection(int start, int length, string replacement)
Parameters
Type |
Name |
Description |
System.Int32 |
start |
The start.
|
System.Int32 |
length |
The length.
|
System.String |
replacement |
The replacement.
|
RestoreReference(String, Int32)
Restores object references after deserialization
Declaration
protected override void RestoreReference(string name, int index)
Parameters
Type |
Name |
Description |
System.String |
name |
|
System.Int32 |
index |
|
Overrides
Declaration
public void UpdatePrevTextRange(ITextRange textRange, int index)
Parameters
Type |
Name |
Description |
ITextRange |
textRange |
|
System.Int32 |
index |
|
UpdateText(ParagraphItem, Int32, String)
Declaration
protected void UpdateText(ParagraphItem pItem, int length, string newText)
Parameters
Type |
Name |
Description |
ParagraphItem |
pItem |
|
System.Int32 |
length |
|
System.String |
newText |
|
Explicit Interface Implementations
Declaration
void IWidget.Draw(CustomGraphics cg, LayoutedWidget ltWidget)
Parameters
Implements