Class Paragraph

A block-level flow content element used to group content into a paragraph.

Inheritance

System.Object

DocumentElementBase

BlockBase

Paragraph

Inherited Members

BlockBase.BlockContainer

DocumentElementBase.EnumerateChildrenOfType<T>()

DocumentElementBase.OnChildAdded(DocumentElementBase)

DocumentElementBase.OnChildRemoved(DocumentElementBase)

DocumentElementBase.Document

DocumentElementBase.Parent

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.Windows.Documents.Flow.Model

Assembly: Telerik.Windows.Documents.Flow.dll

Syntax

public sealed class Paragraph : BlockBase, IElementWithStyle, IElementWithProperties, ISdtBlock, IChildrenList

Constructors

Paragraph(RadFlowDocument)

Initializes a new instance of the Paragraph class.

Declaration

public Paragraph(RadFlowDocument document)

Parameters

RadFlowDocument document The document in which the element will be added.

Fields

AllowOverflowPunctuationPropertyDefinition

Gets the allow overflow punctuation property definition.

Declaration

public static readonly StylePropertyDefinition<bool? > AllowOverflowPunctuationPropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<System.Boolean>>

ApplyEastAsianLineBreakingRulesPropertyDefinition

Gets the apply east asian line breaking rules property definition.

Declaration

public static readonly StylePropertyDefinition<bool? > ApplyEastAsianLineBreakingRulesPropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<System.Boolean>>

AutomaticSpacingAfterPropertyDefinition

Gets the automatic spacing after property definition.

Declaration

public static readonly StylePropertyDefinition<bool? > AutomaticSpacingAfterPropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<System.Boolean>>

AutomaticSpacingBeforePropertyDefinition

Gets the automatic spacing before property definition.

Declaration

public static readonly StylePropertyDefinition<bool? > AutomaticSpacingBeforePropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<System.Boolean>>

BackgroundColorPropertyDefinition

Gets the background color property definition.

Declaration

public static readonly StylePropertyDefinition<ThemableColor> BackgroundColorPropertyDefinition

Field Value

StylePropertyDefinition<ThemableColor>

BordersPropertyDefinition

Gets the paragraph borders property definition.

Declaration

public static readonly StylePropertyDefinition<ParagraphBorders> BordersPropertyDefinition

Field Value

StylePropertyDefinition<ParagraphBorders>

ContextualSpacingPropertyDefinition

Gets the contextual spacing property definition.

Declaration

public static readonly StylePropertyDefinition<bool? > ContextualSpacingPropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<System.Boolean>>

FirstLineIndentPropertyDefinition

Gets the first line indent property definition.

Declaration

public static readonly StylePropertyDefinition<double? > FirstLineIndentPropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<System.Double>>

FlowDirectionPropertyDefinition

Gets the flow direction property definition.

Declaration

public static readonly StylePropertyDefinition<FlowDirection? > FlowDirectionPropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<FlowDirection>>

HangingIndentPropertyDefinition

Gets the hanging indent property definition.

Declaration

public static readonly StylePropertyDefinition<double? > HangingIndentPropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<System.Double>>

KeepOnOnePagePropertyDefinition

Gets the keep on one page property definition.

Declaration

public static readonly StylePropertyDefinition<bool? > KeepOnOnePagePropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<System.Boolean>>

KeepWithNextParagraphPropertyDefinition

Gets the keep with next paragraph property definition.

Declaration

public static readonly StylePropertyDefinition<bool? > KeepWithNextParagraphPropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<System.Boolean>>

LeftIndentPropertyDefinition

Gets the left indent property definition.

Declaration

public static readonly StylePropertyDefinition<double? > LeftIndentPropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<System.Double>>

LineSpacingPropertyDefinition

Gets the line spacing property definition.

Declaration

public static readonly StylePropertyDefinition<double? > LineSpacingPropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<System.Double>>

LineSpacingTypePropertyDefinition

Gets the line spacing type property definition.

Declaration

public static readonly StylePropertyDefinition<HeightType? > LineSpacingTypePropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<HeightType>>

ListIdPropertyDefinition

Gets the list id property definition.

Declaration

public static readonly StylePropertyDefinition<int? > ListIdPropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<System.Int32>>

ListLevelPropertyDefinition

Gets the list level property definition.

Declaration

public static readonly StylePropertyDefinition<int? > ListLevelPropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<System.Int32>>

MirrorIndentsPropertyDefinition

Gets the mirror indents property definition.

Declaration

public static readonly StylePropertyDefinition<bool? > MirrorIndentsPropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<System.Boolean>>

OutlineLevelPropertyDefinition

Gets the outline level property definition.

Declaration

public static readonly StylePropertyDefinition<OutlineLevel? > OutlineLevelPropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<OutlineLevel>>

PageBreakBeforePropertyDefinition

Gets the page break before property definition.

Declaration

public static readonly StylePropertyDefinition<bool? > PageBreakBeforePropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<System.Boolean>>

RightIndentPropertyDefinition

Gets the right indent property definition.

Declaration

public static readonly StylePropertyDefinition<double? > RightIndentPropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<System.Double>>

ShadingPatternColorPropertyDefinition

Gets the shading pattern color property definition.

Declaration

public static readonly StylePropertyDefinition<ThemableColor> ShadingPatternColorPropertyDefinition

Field Value

StylePropertyDefinition<ThemableColor>

ShadingPatternPropertyDefinition

Gets the shading pattern property definition.

Declaration

public static readonly StylePropertyDefinition<ShadingPattern? > ShadingPatternPropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<ShadingPattern>>

SpacingAfterPropertyDefinition

Gets the spacing after property definition.

Declaration

public static readonly StylePropertyDefinition<double? > SpacingAfterPropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<System.Double>>

SpacingBeforePropertyDefinition

Gets the spacing before property definition.

Declaration

public static readonly StylePropertyDefinition<double? > SpacingBeforePropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<System.Double>>

TabStopsPropertyDefinition

Gets the tab stops property definition.

Declaration

public static readonly StylePropertyDefinition<TabStopCollection> TabStopsPropertyDefinition

Field Value

StylePropertyDefinition<TabStopCollection>

TextAlignmentPropertyDefinition

Gets the text alignment property definition.

Declaration

public static readonly StylePropertyDefinition<Alignment? > TextAlignmentPropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<Alignment>>

Properties

AllowOverflowPunctuation

Gets or sets a value indicating whether the last punctuation character on a line can overflow in paragraph margin/indent.

Declaration

public bool AllowOverflowPunctuation { get; set; }

Property Value

System.Boolean The default is true.

ApplyEastAsianLineBreakingRules

Gets or sets a value indicating whether East-Asian line breaking rules are applied to this paragraph.

Declaration

public bool ApplyEastAsianLineBreakingRules { get; set; }

Property Value

System.Boolean The default value is true.

Borders

Gets or sets the borders of this paragraph.

Declaration

public ParagraphBorders Borders { get; set; }

Property Value

ParagraphBorders The borders.

ContextualSpacing

Gets or sets a value indicating whether spacing before/after are ignored when preceding/following paragraph has same paragraph style.

Declaration

public bool ContextualSpacing { get; set; }

Property Value

System.Boolean The default value is false.

FlowDirection

Gets or sets the flow direction.

Declaration

public FlowDirection FlowDirection { get; set; }

Property Value

FlowDirection The default value is LeftToRight

Indentation

Gets the indentation of the paragraph.

Declaration

public ParagraphIndentation Indentation { get; }

Property Value

ParagraphIndentation The indentation.

Inlines

Gets the inlines in this paragraphs.

Declaration

public InlineCollection Inlines { get; }

Property Value

InlineCollection The inlines.

KeepOnOnePage

Gets or sets a value indicating if this paragraph should be rendered on one page when the document is shown in page view mode.

Declaration

public bool KeepOnOnePage { get; set; }

Property Value

System.Boolean The default value is false

KeepWithNextParagraph

Gets or sets a value indicating if this paragraph should be rendered at least partly on the one page with the following paragraph when this is possible and when the document is shown in page view mode.

Declaration

public bool KeepWithNextParagraph { get; set; }

Property Value

System.Boolean The default value is false

ListId

Gets or sets the list id.

Declaration

public int ListId { get; set; }

Property Value

System.Int32 The list id.

ListLevel

Gets a value indicating that the paragraph is referencing list style.

Declaration

public int ListLevel { get; set; }

Property Value

System.Int32 The default value is -1 - list style is not referenced.

MirrorIndents

Gets or sets a value indicating whether left and right indents should be swapped on odd pages.

Declaration

public bool MirrorIndents { get; set; }

Property Value

System.Boolean The default value is false.

OutlineLevel

Gets or sets a value indicating the outline level. The outline level defines the level of this paragraph in TOC field.

Declaration

public OutlineLevel OutlineLevel { get; set; }

Property Value

OutlineLevel The default value is Level9 - no level.

PageBreakBefore

Gets or sets a value indicating if this paragraph should be rendered on new page when the document is shown in page view mode.

Declaration

public bool PageBreakBefore { get; set; }

Property Value

System.Boolean The default value is false

Properties

Gets the styling properties of this element.

Declaration

public ParagraphProperties Properties { get; }

Property Value

ParagraphProperties The properties.

Shading

Gets the shading which shall be applied to the extents of the paragraph.

Declaration

public Shading Shading { get; }

Property Value

Shading The shading.

Spacing

Gets the paragraph spacing.

Declaration

public ParagraphSpacing Spacing { get; }

Property Value

ParagraphSpacing The paragraph spacing.

StyleId

Gets or sets the style id.

Declaration

public string StyleId { get; set; }

Property Value

System.String The style id.

Implements

IElementWithStyle.StyleId

TabStops

Gets or sets the tab stops of the paragraph.

Declaration

public TabStopCollection TabStops { get; set; }

Property Value

TabStopCollection The tab stops.

TextAlignment

Gets the paragraph text alignment.

Declaration

public Alignment TextAlignment { get; set; }

Property Value

Alignment The default value is Left

Methods

Clone()

Creates deep copy of this document element, associated to the current document.

Declaration

public Paragraph Clone()

Returns

Paragraph The cloned element.

Clone(RadFlowDocument)

Creates deep copy of this document element, associated to document.

Declaration

public Paragraph Clone(RadFlowDocument document)

Parameters

RadFlowDocument document The document to which the cloned element should be associated.

Returns

Paragraph The cloned element.

Explicit Interface Implementations

IElementWithProperties.Properties

Gets the properties.

Declaration

DocumentElementPropertiesBase IElementWithProperties.Properties { get; }

Returns

DocumentElementPropertiesBase The properties.

Implements

IElementWithProperties.Properties

Extension Methods

SvgExtentions.Traverse<T>(T, Func<T, IEnumerable<T>>)

SvgExtentions.TraverseDepthFirst<T>(T, Func<T, IEnumerable<T>>)