Table of Contents

Class FormattedText

Namespace
MigraDoc.DocumentObjectModel
Assembly
MigraDoc.DocumentObjectModel.dll

Represents the format of a text.

public class FormattedText : DocumentObject
Inheritance
object
FormattedText
Inherited Members
Extension Methods

Constructors

FormattedText()

Initializes a new instance of the FormattedText class.

Properties

Bold

Gets or sets the bold property.

Color

Gets or sets the color property.

Elements

Gets the collection of paragraph elements that defines the FormattedText.

Font

Gets or sets the font object.

FontName

Gets or sets the name of the font.

Italic

Gets or sets the italic property.

Size

Gets or sets the size in point.

Style

Gets or sets the style name.

Subscript

Gets or sets the subscript property.

Superscript

Gets or sets the superscript property.

Underline

Gets or sets the underline property.

Values

Gets the underlying internal nullable values for the properties of this document object.

Methods

Add(Character)

Adds a new Character.

Add(BookmarkField)

Adds a new Bookmark.

Add(DateField)

Adds a new DateField.

Add(InfoField)

Adds a new InfoField.

Add(NumPagesField)

Adds a new NumPagesField.

Add(PageField)

Adds a new PageField.

Add(PageRefField)

Adds a new PageRefField.

Add(SectionField)

Adds a new SectionField.

Add(SectionPagesField)

Adds a new SectionPagesField.

Add(Footnote)

Adds a new Footnote.

Add(FormattedText)

Adds a new FormattedText.

Add(Hyperlink)

Adds a new Hyperlink.

Add(Image)

Adds a new Image.

Add(Text)

Adds a new Text.

AddBookmark(string, bool)

Adds a new Bookmark.

The name of the bookmark. True, if the bookmark shall be inserted at the beginning of the paragraph.
AddChar(char)

Adds a single character to the formatted text.

AddChar(char, int)

Adds a single character repeated the specified number of times to the formatted text.

AddCharacter(SymbolName)

Adds a Symbol object.

AddCharacter(SymbolName, int)

Adds one or more Symbol objects.

AddCharacter(char)

Adds a Symbol object defined by a character.

AddCharacter(char, int)

Adds one or more Symbol objects defined by a character.

AddDateField()

Adds a new DateField.

AddDateField(string)

Adds a new DateField.

AddFootnote()

Adds a new Footnote.

AddFootnote(string)

Adds a new Footnote with the specified text.

AddFormattedText()

Adds a new FormattedText.

AddFormattedText(Font)

Adds a new FormattedText with the given Font.

AddFormattedText(TextFormat)

Adds a new FormattedText object with the given format.

AddFormattedText(string)

Adds a new FormattedText with the given text.

AddFormattedText(string, Font)

Adds a new FormattedText object with the given text and font.

AddFormattedText(string, TextFormat)

Adds a new FormattedText object with the given text and format.

AddFormattedText(string, string)

Adds a new FormattedText object with the given text and style.

AddHyperlink(string)

Adds a new Hyperlink of Type "Local", i.e. the target is a Bookmark within the Document.

AddHyperlink(string, HyperlinkType)

Adds a new Hyperlink.

AddHyperlink(string, string, HyperlinkTargetWindow)

Adds a new Hyperlink of Type "ExternalBookmark", i.e. the target is a Bookmark in an external PDF Document.

AddHyperlinkToEmbeddedDocument(string, HyperlinkTargetWindow)

Adds a new Hyperlink of Type "EmbeddedDocument". The target is a Bookmark in an embedded Document in this Document.

AddHyperlinkToEmbeddedDocument(string, string, HyperlinkTargetWindow)

Adds a new Hyperlink of Type "EmbeddedDocument". The target is a Bookmark in an embedded Document in an external PDF Document.

AddImage(string)

Adds a new Image object.

AddInfoField(InfoFieldType)

Adds a new InfoField.

AddLineBreak()

Adds a line break.

AddMailLink(string)

Adds a new Hyperlink using the mailto protocol. The protocol is automatically added if missing.

AddNumPagesField()

Adds a new NumPagesField.

AddPageField()

Adds a new PageField.

AddPageRefField(string)

Adds a new PageRefField.

AddSectionField()

Adds a new SectionField.

AddSectionPagesField()

Adds a new SectionPagesField.

AddSpace(int)

Adds one or more Space characters.

AddTab()

Adds a horizontal tab.

AddText(string)

Adds a text phrase to the formatted text.

AddWebLink(string)

Adds a new Hyperlink using the HTTP or HTTPS protocol. The HTTP protocol is automatically added if neither HTTP nor HTTPS is specified.

Clone()

Creates a deep copy of this object.

DeepCopy()

Implements the deep copy of the object.