• DR-IT Software
  • Products
  • Documentation
  • Product page
  • Examples
  • API reference
  • Support
Show / Hide Table of Contents

Class FormattedText

Represents formatted text in a Shape.

Inheritance
object
FormattedText
Inherited Members
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Namespace: DRIT.Spreadsheet.Drawing
Assembly: DRIT.Spreadsheet.dll
Syntax
public class FormattedText

Properties

AllowTextToOverflowShape

Exposes the allow text to overflow shape associated with FormattedText.

Declaration
public bool AllowTextToOverflowShape { get; set; }
Property Value
Type Description
bool

The allow text to overflow shape returned by the operation.

BodyEffects

Exposes the body effects associated with FormattedText.

Declaration
public TextBodyEffects BodyEffects { get; }
Property Value
Type Description
TextBodyEffects

The body effects returned by the operation.

ColumnNumber

Exposes the column number associated with FormattedText.

Declaration
public int ColumnNumber { get; set; }
Property Value
Type Description
int

The column number returned by the operation.

ColumnSpacing

Exposes the column spacing associated with FormattedText.

Declaration
public double ColumnSpacing { get; set; }
Property Value
Type Description
double

The column spacing returned by the operation.

CustomAngle

Exposes the custom angle associated with FormattedText.

Declaration
public int? CustomAngle { get; set; }
Property Value
Type Description
int?

The custom angle returned by the operation.

Font

Exposes the font associated with FormattedText.

Declaration
public DrawingFont Font { get; }
Property Value
Type Description
DrawingFont

The font returned by the operation.

Margin

Exposes the margin associated with FormattedText.

Declaration
public Margin Margin { get; }
Property Value
Type Description
Margin

The margin returned by the operation.

Paragraphs

Exposes the paragraphs associated with FormattedText.

Declaration
public ParagraphCollection Paragraphs { get; }
Property Value
Type Description
ParagraphCollection

The paragraphs returned by the operation.

ResizeShapeToFitText

Exposes the resize shape to fit text associated with FormattedText.

Declaration
public bool ResizeShapeToFitText { get; set; }
Property Value
Type Description
bool

The resize shape to fit text returned by the operation.

Text

Exposes the text associated with FormattedText.

Declaration
public string Text { get; set; }
Property Value
Type Description
string

The text returned by the operation.

TextDirection

Exposes the text direction associated with FormattedText.

Declaration
public TextDirection TextDirection { get; set; }
Property Value
Type Description
TextDirection

The text direction returned by the operation.

VerticalAlignment

Exposes the vertical alignment associated with FormattedText.

Declaration
public TextBoxVerticalAlignment VerticalAlignment { get; set; }
Property Value
Type Description
TextBoxVerticalAlignment

The vertical alignment returned by the operation.

WrapText

Exposes the wrap text associated with FormattedText.

Declaration
public bool WrapText { get; set; }
Property Value
Type Description
bool

The wrap text returned by the operation.

Methods

AddParagraph()

Adds a new paragraph to this text body and returns it.

Declaration
public DrawingTextParagraph AddParagraph()
Returns
Type Description
DrawingTextParagraph

AppendText(string)

Adds the supplied end text to the FormattedText.

Declaration
public void AppendText(string text)
Parameters
Type Name Description
string text

The text used by the operation.

FindAll(string, TextSearchOptions)

Retrieves the requested d all from the FormattedText.

Declaration
public IReadOnlyList<TextRange> FindAll(string searchText, TextSearchOptions options)
Parameters
Type Name Description
string searchText
TextSearchOptions options
Returns
Type Description
IReadOnlyList<TextRange>

The find all returned by the operation.

FindAll(string, StringComparison)

Retrieves the requested d all from the FormattedText.

Declaration
public IReadOnlyList<TextRange> FindAll(string searchText, StringComparison comparison = StringComparison.Ordinal)
Parameters
Type Name Description
string searchText
StringComparison comparison
Returns
Type Description
IReadOnlyList<TextRange>

The find all returned by the operation.

FindAll(Regex)

Retrieves the requested d all from the FormattedText.

Declaration
public IReadOnlyList<TextRange> FindAll(Regex regex)
Parameters
Type Name Description
Regex regex

The regex used by the operation.

Returns
Type Description
IReadOnlyList<TextRange>

The find all returned by the operation.

FindFirst(string, StringComparison)

Retrieves the requested d first from the FormattedText.

Declaration
public TextRange FindFirst(string searchText, StringComparison comparison = StringComparison.Ordinal)
Parameters
Type Name Description
string searchText
StringComparison comparison
Returns
Type Description
TextRange

The find first returned by the operation.

Replace(string, string, TextSearchOptions)

Exposes the replace associated with FormattedText.

Declaration
public int Replace(string oldValue, string newValue, TextSearchOptions options)
Parameters
Type Name Description
string oldValue
string newValue
TextSearchOptions options
Returns
Type Description
int

The replace returned by the operation.

Replace(string, string, StringComparison)

Exposes the replace associated with FormattedText.

Declaration
public int Replace(string oldValue, string newValue, StringComparison comparison = StringComparison.Ordinal)
Parameters
Type Name Description
string oldValue
string newValue
StringComparison comparison
Returns
Type Description
int

The replace returned by the operation.

Replace(Regex, string)

Exposes the replace associated with FormattedText.

Declaration
public int Replace(Regex regex, string replacement)
Parameters
Type Name Description
Regex regex

The regex used by the operation.

string replacement

The replacement used by the operation.

Returns
Type Description
int

The replace returned by the operation.

Back to top

DR-IT Software documentation

DR-IT Software · Products · Documentation index · Product page · Downloads · Support · Licensing

Generated by DocFX