Class Paragraph

Inheritance
System.Object
DisposableObject
RadObject
DocumentElement
Block
Paragraph
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinForms.Documents.Model
Assembly: Telerik.WinControls.RichTextEditor.dll

Syntax

public class Paragraph : Block, IDisposable, INotifyPropertyChanged, ICustomTypeDescriptor

Constructors

Paragraph()

Initializes a new instance of the Paragraph class.

Declaration
public Paragraph()

Paragraph(Paragraph)

Initializes a new instance of the Paragraph class by copying an already existing Paragraph.

Declaration
public Paragraph(Paragraph originalParagraph)
Parameters
Paragraph originalParagraph

The original paragraph.

Fields

AutomaticSpacingAfterProperty

Declaration
public static readonly StylePropertyDefinition<bool? , ParagraphProperties> AutomaticSpacingAfterProperty
Field Value
StylePropertyDefinition<System.Nullable<System.Boolean>, ParagraphProperties>

AutomaticSpacingBeforeProperty

Declaration
public static readonly StylePropertyDefinition<bool? , ParagraphProperties> AutomaticSpacingBeforeProperty
Field Value
StylePropertyDefinition<System.Nullable<System.Boolean>, ParagraphProperties>

BackgroundProperty

Declaration
public static readonly StylePropertyDefinition<Color? , ParagraphProperties> BackgroundProperty
Field Value
StylePropertyDefinition<System.Nullable<Color>, ParagraphProperties>

FirstLineIndentProperty

Declaration
public static readonly StylePropertyDefinition<double? , ParagraphProperties> FirstLineIndentProperty
Field Value
StylePropertyDefinition<System.Nullable<System.Double>, ParagraphProperties>

FlowDirectionProperty

The flow direction property.

Declaration
public static readonly StylePropertyDefinition<FlowDirection? , ParagraphProperties> FlowDirectionProperty
Field Value
StylePropertyDefinition<System.Nullable<FlowDirection>, ParagraphProperties>

IsLineBreakingRuleEnabledProperty

Declaration
public static readonly StylePropertyDefinition<bool? , ParagraphProperties> IsLineBreakingRuleEnabledProperty
Field Value
StylePropertyDefinition<System.Nullable<System.Boolean>, ParagraphProperties>

KeepLinesProperty

Declaration
public static readonly StylePropertyDefinition<bool? , ParagraphProperties> KeepLinesProperty
Field Value
StylePropertyDefinition<System.Nullable<System.Boolean>, ParagraphProperties>

LeftIndentProperty

Declaration
public static readonly StylePropertyDefinition<double? , ParagraphProperties> LeftIndentProperty
Field Value
StylePropertyDefinition<System.Nullable<System.Double>, ParagraphProperties>

LineSpacingProperty

Declaration
public static readonly StylePropertyDefinition<double? , ParagraphProperties> LineSpacingProperty
Field Value
StylePropertyDefinition<System.Nullable<System.Double>, ParagraphProperties>

LineSpacingTypeProperty

Declaration
public static readonly StylePropertyDefinition<LineSpacingType? , ParagraphProperties> LineSpacingTypeProperty
Field Value
StylePropertyDefinition<System.Nullable<LineSpacingType>, ParagraphProperties>

ListIdProperty

Declaration
public static readonly StylePropertyDefinition<int? , ParagraphProperties> ListIdProperty
Field Value
StylePropertyDefinition<System.Nullable<System.Int32>, ParagraphProperties>

ListLevelProperty

Declaration
public static readonly StylePropertyDefinition<int? , ParagraphProperties> ListLevelProperty
Field Value
StylePropertyDefinition<System.Nullable<System.Int32>, ParagraphProperties>

OutlineLevelProperty

Declaration
public static readonly StylePropertyDefinition<int? , ParagraphProperties> OutlineLevelProperty
Field Value
StylePropertyDefinition<System.Nullable<System.Int32>, ParagraphProperties>

RightIndentProperty

Declaration
public static readonly StylePropertyDefinition<double? , ParagraphProperties> RightIndentProperty
Field Value
StylePropertyDefinition<System.Nullable<System.Double>, ParagraphProperties>

SpacingAfterProperty

Declaration
public static readonly StylePropertyDefinition<double? , ParagraphProperties> SpacingAfterProperty
Field Value
StylePropertyDefinition<System.Nullable<System.Double>, ParagraphProperties>

SpacingBeforeProperty

Declaration
public static readonly StylePropertyDefinition<double? , ParagraphProperties> SpacingBeforeProperty
Field Value
StylePropertyDefinition<System.Nullable<System.Double>, ParagraphProperties>

SuppressLineNumbersProperty

Declaration
public static readonly StylePropertyDefinition<bool? , ParagraphProperties> SuppressLineNumbersProperty
Field Value
StylePropertyDefinition<System.Nullable<System.Boolean>, ParagraphProperties>

TextAlignmentProperty

Declaration
public static readonly StylePropertyDefinition<RadTextAlignment? , ParagraphProperties> TextAlignmentProperty
Field Value
StylePropertyDefinition<System.Nullable<RadTextAlignment>, ParagraphProperties>

ThemeBackgroundProperty

Declaration
public static readonly StylePropertyDefinition<ThemeColorsEnum? , ParagraphProperties> ThemeBackgroundProperty
Field Value
StylePropertyDefinition<System.Nullable<ThemeColorsEnum>, ParagraphProperties>

ThemeFillShadeProperty

Declaration
public static readonly StylePropertyDefinition<string, ParagraphProperties> ThemeFillShadeProperty
Field Value
StylePropertyDefinition<System.String, ParagraphProperties>

ThemeFillTintProperty

Declaration
public static readonly StylePropertyDefinition<string, ParagraphProperties> ThemeFillTintProperty
Field Value
StylePropertyDefinition<System.String, ParagraphProperties>

Properties

AutomaticSpacingAfter

Declaration
[XamlSerializable]
public bool AutomaticSpacingAfter { get; set; }
Property Value
System.Boolean

AutomaticSpacingBefore

Gets or sets a value indicating whether an automatic spacing before should be applied.

Declaration
[XamlSerializable]
public bool AutomaticSpacingBefore { get; set; }
Property Value
System.Boolean

true if [automatic spacing before]; otherwise, false.

Background

Gets or sets the background.

Declaration
[XamlSerializable]
public Color Background { get; set; }
Property Value
Color

The background.

ElementRevisionInfo

Gets or sets the information for revisions on this element.

Declaration
[XamlCompositePropertySerializable]
public DocumentElementRevisionInfo ElementRevisionInfo { get; set; }
Property Value
DocumentElementRevisionInfo

The element revision information.

FirstLineIndent

Gets or sets the first line indent.

Declaration
[XamlSerializable]
public double FirstLineIndent { get; set; }
Property Value
System.Double

The first line indent.

FlowDirection

Gets or sets the flow direction.

Declaration
[XamlSerializable(FlowDirection.LeftToRight)]
public FlowDirection FlowDirection { get; set; }
Property Value
FlowDirection

A value of type FlowDirection.

FontSize

Gets or sets the size of the font for the last paragraph marker.

Declaration
[XamlSerializable]
public double FontSize { get; set; }
Property Value
System.Double

The size of the font.

HangingIndent

Gets or sets the hanging indent.

Declaration
public double HangingIndent { get; set; }
Property Value
System.Double

The hanging indent.

HasRevisions

Gets a value indicating whether this instance has revisions.

Declaration
public bool HasRevisions { get; }
Property Value
System.Boolean

true if this instance has revisions; otherwise, false.

Inlines

Gets the collection of Inline elements added as children to this paragraph.

Declaration
public InlineCollection Inlines { get; }
Property Value
InlineCollection

The inlines.

IsDeleted

Gets a value indicating whether this instance has been deleted into document with enabled Track Changes.

Declaration
public bool IsDeleted { get; }
Property Value
System.Boolean

true if this instance is deleted; otherwise, false.

IsEmpty

Gets a value indicating whether this paragraph is empty.

Declaration
public bool IsEmpty { get; }
Property Value
System.Boolean

true if the paragraph doesn't contain inlines; otherwise, false.

IsHeading

Gets a value indicating whether a heading style is applied to this paragraph.

Declaration
public bool IsHeading { get; }
Property Value
System.Boolean

true if this instance has a heading style; otherwise, false.

IsInList

Gets a value indicating whether this paragraph is included in a list.

Declaration
public bool IsInList { get; }
Property Value
System.Boolean

true if this instance is in list; otherwise, false.

IsInserted

Gets a value indicating whether this instance has been inserted into document with enabled Track Changes.

Declaration
public bool IsInserted { get; }
Property Value
System.Boolean

true if this instance is inserted; otherwise, false.

IsLineBreakingRuleEnabled

Gets or sets a value indicating whether East Asian typography rules will be applied to determine which characters may begin and end each line.

Declaration
[XamlSerializable(true)]
public bool IsLineBreakingRuleEnabled { get; set; }
Property Value
System.Boolean

KeepLines

Declaration
[XamlSerializable(false)]
public bool KeepLines { get; set; }
Property Value
System.Boolean

LeftIndent

Gets or sets the left indent.

Declaration
[XamlSerializable]
public double LeftIndent { get; set; }
Property Value
System.Double

The left indent.

LineSpacing

Gets or sets the spacing between the different lines of the paragraph.

Declaration
[XamlSerializable]
public double LineSpacing { get; set; }
Property Value
System.Double

The line spacing.

LineSpacingType

Declaration
[XamlSerializable]
public LineSpacingType LineSpacingType { get; set; }
Property Value
LineSpacingType

ListId

Gets or sets identifier number of the list the paragraph is included in. The default value is -1 - the paragraph is not included in a list.

Declaration
[XamlSerializable(-1)]
public int ListId { get; set; }
Property Value
System.Int32

The list identifier.

ListItemInfo

Declaration
public ListItemInfo ListItemInfo { get; set; }
Property Value
ListItemInfo

ListItemSerializationData

Declaration
public ListItemSerializationData ListItemSerializationData { get; set; }
Property Value
ListItemSerializationData

ListItemSerializationInfo

Declaration
public ListItemSerializationInfo ListItemSerializationInfo { get; set; }
Property Value
ListItemSerializationInfo

ListLevel

Gets or sets the list level.

Declaration
[XamlSerializable(0)]
public int ListLevel { get; set; }
Property Value
System.Int32

The list level.

NumberSkip

Declaration
[XamlSerializable(0)]
public int NumberSkip { get; set; }
Property Value
System.Int32

OutlineLevel

Gets or sets a value indicating the outline level. The outline level defines the level of this paragraph in TOC field. The default value is 0 - no level.

Declaration
[XamlSerializable(0)]
public int OutlineLevel { get; set; }
Property Value
System.Int32

The outline level.

ParagraphSymbolPropertiesStyle

Declaration
[XamlCompositePropertySerializable]
public SpanProperties ParagraphSymbolPropertiesStyle { get; set; }
Property Value
SpanProperties

RightIndent

Gets or sets the right indent.

Declaration
[XamlSerializable]
public double RightIndent { get; set; }
Property Value
System.Double

The right indent.

SpacingAfter

Declaration
[XamlSerializable]
public double SpacingAfter { get; set; }
Property Value
System.Double

SpacingBefore

Gets or sets the spacing before the paragraph.

Declaration
[XamlSerializable]
public double SpacingBefore { get; set; }
Property Value
System.Double

The spacing before.

SuppressLineNumbers

Gets or sets the value indicating whether the line numbering for the current Paragraph is suppressed.

Declaration
[XamlSerializable]
public bool SuppressLineNumbers { get; set; }
Property Value
System.Boolean

The line numbering.

TabStops

Gets or sets the tab stops.

Declaration
[XamlCompositePropertySerializable]
public TabStopCollection TabStops { get; set; }
Property Value
TabStopCollection

The tab stops.

TextAlignment

Gets or sets the text alignment.

Declaration
[XamlSerializable]
public RadTextAlignment TextAlignment { get; set; }
Property Value
RadTextAlignment

A value of type RadTextAlignment.

ThemeBackground

Gets or sets the theme background.

Declaration
[XamlSerializable]
public ThemeColorsEnum ThemeBackground { get; set; }
Property Value
ThemeColorsEnum

The theme background.

ThemeFillShade

Gets or sets the theme fill shade.

Declaration
[XamlSerializable]
public string ThemeFillShade { get; set; }
Property Value
System.String

The theme fill shade.

ThemeFillTint

Gets or sets the theme fill tint.

Declaration
[XamlSerializable]
public string ThemeFillTint { get; set; }
Property Value
System.String

The theme fill tint.

Methods

ChangeLeftIndent(Double)

Declaration
[Obsolete("Use Paragraph.LeftIndent property or DocumentList.IncreaseLeftIndent method.")]
public void ChangeLeftIndent(double newLeftIndent)
Parameters
System.Double newLeftIndent

CopyPropertiesFromOverride(DocumentElement)

Copies the properties from another Paragraph to the current instance.

Declaration
protected override void CopyPropertiesFromOverride(DocumentElement fromElement)
Parameters
DocumentElement fromElement

The Paragraph to copy the properties from.
Overrides

CreateDeepCopy()

Creates a deep copy of the element.

Declaration
public override DocumentElement CreateDeepCopy()
Returns
DocumentElement

The copied element.
Overrides

CreateLayoutBox(DocumentStructureCollection)

Creates a ParagraphLayoutBox for the element.

Declaration
public override LayoutBox CreateLayoutBox(DocumentStructureCollection documentCollection)
Parameters
DocumentStructureCollection documentCollection

The document collection.
Returns
LayoutBox

Overrides

CreateNewElementInstance()

Creates a new Paragraph instance.

Declaration
protected override DocumentElement CreateNewElementInstance()
Returns
DocumentElement

The new instance.
Overrides

DecreaseLeftIndent()

Declaration
[Obsolete("Use Paragraph.LeftIndent or RadDocumentEditor.DecreaseLeftIndent instead.")]
public void DecreaseLeftIndent()

HasSameStyle(Paragraph)

Determines whether the current instance has the same style properties as another one.

Declaration
public virtual bool HasSameStyle(Paragraph other)
Parameters
Paragraph other

The other.
Returns
System.Boolean

true if the current instance has the same style properties as the other one; otherwise, false.

IncreaseLeftIndent()

Declaration
[Obsolete("Use Paragraph.LeftIndent or RadDocumentEditor.IncreaseLeftIndent instead.")]
public void IncreaseLeftIndent()

IsInBulletedList(RadDocument)

Declaration
public bool IsInBulletedList(RadDocument document)
Parameters
RadDocument document

Returns
System.Boolean

IsInNumberedList(RadDocument)

Declaration
public bool IsInNumberedList(RadDocument document)
Parameters
RadDocument document

Returns
System.Boolean

OnRemoved()

Declaration
protected override void OnRemoved()
Overrides

OnStyleChanged()

Declaration
protected override void OnStyleChanged()
Overrides

OnStyleChanging()

Declaration
protected override void OnStyleChanging()
Overrides

OnTabStopsChanged()

Called when TabStops collection changes.

Declaration
protected virtual void OnTabStopsChanged()

RemoveFromList()

Removes the paragraph from a list.

Declaration
public void RemoveFromList()

Events

TabStopsChanged

Occurs when the TabStops collection changes.

Declaration
public event EventHandler TabStopsChanged
Event Type
System.EventHandler

Extension Methods