Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

...

Description

Excerpt

Creates and returns a Paragraph object that represents a new empty paragraph at the beginning of this Element. The paragraph that is inserted will have the style specified, to which any additional specified paragraph formatting is applied as well. If this Element is in the middle of a paragraph, the containing paragraph will be split.

Signature
C#
C#
 public virtual Paragraph InsertParagraphBefore(NamedStyle style, ParagraphFormatting props)
{signature}{signature:
}
Signature
vb.net
vb.net
Public Overridable Function InsertParagraphBefore(ByVal style As NamedStyle, ByVal props As ParagraphFormatting) As Paragraph
{signature}
{parameters}
{param:style}A [NamedStyle] object representing the base style of this paragraph. The base style also affects the character style of any text added to this paragraph. If this is null, the style will be "Normal".{param}
{param:props}A [ParagraphFormatting|ParagraphFormatting] that represents formatting properties that should override the paragraph properties found in the style.{param}
{returns}A {{Paragraph}} object that represents a new empty paragraph at the beginning of this Element. Even though the paragraph is empty there will always be at least a single carriage return.{returns}
{example}{code:csharp|title=C#}
Parameters
Param
style
style

A NamedStyle object representing the base style of this paragraph. The base style also affects the character style of any text added to this paragraph. If this is null, the style will be "Normal".

Param
props
props

A ParagraphFormatting that represents formatting properties that should override the paragraph properties found in the style.

Returns

A Paragraph object that represents a new empty paragraph at the beginning of this Element. Even though the paragraph is empty there will always be at least a single carriage return.

Example
Code Block
csharp
csharp
titleC#

Paragraph p = e.InsertParagraphBefore(doc.Styles[NamedStyle.BuiltIn.Normal], pFormatting);
{code} {code:
Code Block
vb.net
|title=
vb.net
titlevb.net
}

Dim p As Paragraph = e.InsertParagraphBefore(doc.Styles(NamedStyle.BuiltIn.Normal), pFormatting)
{code} {example}