New to Telerik UI for WPF? Start a free 30-day trial

Note

Class

Represents a note in the Telerik document model, which can store text and associated metadata.

Definition

Namespace:Telerik.Windows.Documents.Model.Notes

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:

public class Note : ChildDocumentContainer

Inheritance: objectChildDocumentContainerNote

Inherited Members ChildDocumentContainer.BodyChangingChildDocumentContainer.BodyChanged

Constructors

Note()

public Note()

Properties

Body

RadDocument

Gets or sets the body text of the note.

[XamlSerializable]
public override RadDocument Body { get; set; }

Property Value:

A string representing the content of the note's body.

Overrides: ChildDocumentContainer.Body

CustomMark

string

Represents a custom mark in a note, allowing for additional annotations or highlights.

[XamlSerializable]
public string CustomMark { get; set; }

HasCustomMark

bool

Gets a value indicating whether the note has a custom mark applied.

public bool HasCustomMark { get; }

Methods

CreateCustomMarkEndnote(string, FontFamily)

Creates a custom mark for an endnote with the specified text and font family.

public static Note CreateCustomMarkEndnote(string symbol, FontFamily fontFamily = null)

Parameters:symbolstring

The text to display as the endnote mark.

fontFamilyFontFamily

The font family to apply to the endnote mark.

Returns:

Note

A new instance of the custom endnote mark.

CreateCustomMarkFootnote(string, FontFamily)

Creates a custom mark footnote with the specified text and font family.

public static Note CreateCustomMarkFootnote(string symbol, FontFamily fontFamily = null)

Parameters:symbolstring

The text content of the footnote.

fontFamilyFontFamily

The font family to be used for the footnote text.

Returns:

Note

A Note object representing the custom mark footnote.

CreateDeepCopy()

Creates a deep copy of the current Note instance.

public Note CreateDeepCopy()

Returns:

Note

A new Note object that is a deep copy of the original instance.

CreateDefaultEndnote()

Creates a default endnote.

public static Note CreateDefaultEndnote()

Returns:

Note

A new instance of the Note class representing the default endnote.

CreateDefaultFootnote()

Creates a default footnote in the document model.

public static Note CreateDefaultFootnote()

Returns:

Note

A new instance of the Note class representing the footnote.

OnBodyChanged()

protected override void OnBodyChanged()

Overrides: ChildDocumentContainer.OnBodyChanged()

OnBodyChanging()

protected override void OnBodyChanging()

Overrides: ChildDocumentContainer.OnBodyChanging()