HeaderFooter.Comments Property — TX Text Control .NET for WPF

Comments Property

Property|Introduced in 30.0

Namespace: TXTextControl

Package: TXTextControl.TextControl.WPF.SDK as TXTextControl.dll from the private NuGet feed or Text Control Offline Packages

Description

Gets a collection of all comments in the header or footer. The property's value is an object of the type CommentCollection.

Syntax

public CommentCollection Comments { get; }

Public ReadOnly Property Comments As CommentCollection

Examples

The following example creates a header for the first section and configures its content or layout by using HeaderFooter.Comments.

HeaderFooterCollection headers = textControl.Sections[1].HeadersAndFooters;
headers.Add(HeaderFooterType.Header);
HeaderFooter headerFooter = headers.GetItem(HeaderFooterType.Header);
headerFooter.Selection.Text = "Quarterly report";

foreach (CommentedText commentedText in headerFooter.Comments)
{
    Console.WriteLine(commentedText.Active);
}

Dim headers As HeaderFooterCollection = textControl.Sections(1).HeadersAndFooters
headers.Add(HeaderFooterType.Header)
Dim headerFooter As HeaderFooter = headers.GetItem(HeaderFooterType.Header)
headerFooter.Selection.Text = "Quarterly report"

For Each commentedText As CommentedText In headerFooter.Comments
    Console.WriteLine(commentedText.Active)
Next

Limitations

Read only.