Class ParagraphProperties

Defines a set of properties which can be applied to a Paragraph element.

Inheritance
System.Object
DocumentElementPropertiesBase
ParagraphProperties
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.Windows.Documents.Flow.Model.Styles
Assembly: Telerik.Windows.Documents.Flow.dll

Syntax

public sealed class ParagraphProperties : DocumentElementPropertiesBase, IElementWithStyle, IPropertiesWithShading

Properties

AllowOverflowPunctuation

Gets local style property used to get or set a value indicating whether the last punctuation character on a line can overflow in paragraph margin/indent. This property cannot be derived from a style.

Declaration
public IStyleProperty<bool? > AllowOverflowPunctuation { get; }
Property Value
IStyleProperty<System.Nullable<System.Boolean>>

The default is true.

ApplyEastAsianLineBreakingRules

Gets style property used to get or set a value indicating whether East-Asian line breaking rules are applied to this paragraph.

Declaration
public IStyleProperty<bool? > ApplyEastAsianLineBreakingRules { get; }
Property Value
IStyleProperty<System.Nullable<System.Boolean>>

The default value is true.

AutomaticSpacingAfter

Gets style property used to get or set a value indicating whether a consumer shall automatically determine the spacing after the paragraph based on its contents the automatic spacing after.

Declaration
public IStyleProperty<bool? > AutomaticSpacingAfter { get; }
Property Value
IStyleProperty<System.Nullable<System.Boolean>>

The automatic spacing after.

AutomaticSpacingBefore

Gets style property used to get or set a value indicating whether a consumer shall automatically determine the spacing before the paragraph based on its contents the automatic spacing after.

Declaration
public IStyleProperty<bool? > AutomaticSpacingBefore { get; }
Property Value
IStyleProperty<System.Nullable<System.Boolean>>

The automatic spacing after.

BackgroundColor

Gets style property used to get or set the color of the background.

Declaration
public IStyleProperty<ThemableColor> BackgroundColor { get; }
Property Value
IStyleProperty<ThemableColor>

The color of the background.
Implements

Borders

Gets style property used to get or set the paragraph borders.

Declaration
public IStyleProperty<ParagraphBorders> Borders { get; }
Property Value
IStyleProperty<ParagraphBorders>

The paragraph borders.

ContextualSpacing

Gets style property used to get or set a value indicating whether spacing before/after are ignored when preceding/following paragraph has same paragraph style.

Declaration
public IStyleProperty<bool? > ContextualSpacing { get; }
Property Value
IStyleProperty<System.Nullable<System.Boolean>>

The default value is false.

FirstLineIndent

Gets style property used to get or set a value indicating the additional indentation which shall be applied to the first line of the paragraph. The value is in device independent pixels (1/96 inch).

Declaration
public IStyleProperty<double? > FirstLineIndent { get; }
Property Value
IStyleProperty<System.Nullable<System.Double>>

The first line indent.

FlowDirection

Gets style property used to get or set the flow direction.

Declaration
public IStyleProperty<FlowDirection? > FlowDirection { get; }
Property Value
IStyleProperty<System.Nullable<FlowDirection>>

The default value is LeftToRight

HangingIndent

Gets style property used to get or set a value which shall be removed from the indentation of the first line of the paragraph, by moving the indentation on the first line back towards the beginning of the direction of text flow. The value is in device independent pixels (1/96 inch).

Declaration
public IStyleProperty<double? > HangingIndent { get; }
Property Value
IStyleProperty<System.Nullable<System.Double>>

The hanging indent.

KeepOnOnePage

Gets style property used to get or set a value indicating if this paragraph should be rendered on one page when the document is shown in page view mode.

Declaration
public IStyleProperty<bool? > KeepOnOnePage { get; }
Property Value
IStyleProperty<System.Nullable<System.Boolean>>

The default value is false

KeepWithNextParagraph

Gets style property used to get or set 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 IStyleProperty<bool? > KeepWithNextParagraph { get; }
Property Value
IStyleProperty<System.Nullable<System.Boolean>>

The default value is false

LeftIndent

Gets style property used to get or set a value indicating the indentation which shall be applied to the left side of the whole paragraph. The value is in device independent pixels (1/96 inch).

Declaration
public IStyleProperty<double? > LeftIndent { get; }
Property Value
IStyleProperty<System.Nullable<System.Double>>

The left indent.

LineSpacing

Gets style property used to get or set the value indicating the amount of vertical spacing between lines of text within a paragraph.

If LineSpacingType is Auto then the line height value times the value of the property, otherwise the value is in device independent pixels (1/96 inch).

Declaration
public IStyleProperty<double? > LineSpacing { get; }
Property Value
IStyleProperty<System.Nullable<System.Double>>

The line spacing value.

LineSpacingType

Gets style property used to get or set the value indicating how the spacing between lines is calculated.

Declaration
public IStyleProperty<HeightType? > LineSpacingType { get; }
Property Value
IStyleProperty<System.Nullable<HeightType>>

The type line spacing rule.

ListId

Gets style property used to get or set a value indicating that the paragraph is referencing a list.

Declaration
public IStyleProperty<int? > ListId { get; }
Property Value
IStyleProperty<System.Nullable<System.Int32>>

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

ListLevel

Gets style property used to get or set a value indicating that the paragraph is referencing list level.

Declaration
public IStyleProperty<int? > ListLevel { get; }
Property Value
IStyleProperty<System.Nullable<System.Int32>>

The default value is -1 - list level is not referenced.

MirrorIndents

Gets style property used to get or set a value indicating whether left and right indents should be swapped on odd pages.

Declaration
public IStyleProperty<bool? > MirrorIndents { get; }
Property Value
IStyleProperty<System.Nullable<System.Boolean>>

The default value is false.

OutlineLevel

Gets style property used to get or set a value indicating the outline level. The outline level defines the level of this paragraph in TOC field.

Declaration
public IStyleProperty<OutlineLevel? > OutlineLevel { get; }
Property Value
IStyleProperty<System.Nullable<OutlineLevel>>

The default value is Level9 - no level.

PageBreakBefore

Gets style property used to get or set a value indicating if this paragraph should be rendered on new page when the document is shown in page view mode.

Declaration
public IStyleProperty<bool? > PageBreakBefore { get; }
Property Value
IStyleProperty<System.Nullable<System.Boolean>>

The default value is false

ParagraphMarkerProperties

Gets style property used to get or set the formatting properties of the glyph used to represent this paragraph.

Declaration
public CharacterProperties ParagraphMarkerProperties { get; }
Property Value
CharacterProperties

The paragraph marker properties.

RightIndent

Gets style property used to get or set a value indicating the indentation which shall be applied to the right side of the whole paragraph. The value is in device independent pixels (1/96 inch).

Declaration
public IStyleProperty<double? > RightIndent { get; }
Property Value
IStyleProperty<System.Nullable<System.Double>>

The left indent.

ShadingPattern

Gets style property used to get or set a value indicating the pattern which shall be used to lay the pattern color over the background color for this shading.

Declaration
public IStyleProperty<ShadingPattern? > ShadingPattern { get; }
Property Value
IStyleProperty<System.Nullable<ShadingPattern>>

The default value is Clear
Implements

ShadingPatternColor

Gets style property used to get or set a value indicating the color for any foreground pattern used in this shading.

Declaration
public IStyleProperty<ThemableColor> ShadingPatternColor { get; }
Property Value
IStyleProperty<ThemableColor>

The color of the pattern.
Implements

SpacingAfter

Gets style property used to get or set the spacing that should be added after the last line in a paragraph. The value is in device independent pixels (1/96 inch).

Declaration
public IStyleProperty<double? > SpacingAfter { get; }
Property Value
IStyleProperty<System.Nullable<System.Double>>

The spacing after value.

SpacingBefore

Gets style property used to get or set the spacing that should be added above the first line in a paragraph. The value is in device independent pixels (1/96 inch).

Declaration
public IStyleProperty<double? > SpacingBefore { get; }
Property Value
IStyleProperty<System.Nullable<System.Double>>

The spacing before value.

TabStops

Gets the style property used to get or set the tab stops in the paragraph.

Declaration
public IStyleProperty<TabStopCollection> TabStops { get; }
Property Value
IStyleProperty<TabStopCollection>

The tab stops.

TextAlignment

Gets style property used to get or set the paragraph text alignment.

Declaration
public IStyleProperty<Alignment? > TextAlignment { get; }
Property Value
IStyleProperty<System.Nullable<Alignment>>

The default value is Left

Methods

CopyPropertiesFrom(DocumentElementPropertiesBase)

Copy properties from specified source.

Declaration
public override void CopyPropertiesFrom(DocumentElementPropertiesBase fromProperties)
Parameters
DocumentElementPropertiesBase fromProperties

The source from which to copy the properties.
Overrides

EnumerateStyleProperties()

Enumerates the style properties.

Declaration
protected override IEnumerable<IStyleProperty> EnumerateStyleProperties()
Returns
System.Collections.Generic.IEnumerable<IStyleProperty>

The style properties.
Overrides

GetStylePropertyOverride(IStylePropertyDefinition)

Gets specific style property or null.

Declaration
protected override IStyleProperty GetStylePropertyOverride(IStylePropertyDefinition propertyDefinition)
Parameters
IStylePropertyDefinition propertyDefinition

The property definition.
Returns
IStyleProperty

Overrides

Explicit Interface Implementations

IPropertiesWithShading.Document

Gets the document.

Declaration
RadFlowDocument IPropertiesWithShading.Document { get; }
Returns
RadFlowDocument

The document.
Implements

Extension Methods