FixedDocument.DocumentPaginator Property

Reference

Definition

Namespace:: System.Windows.Documents

Assembly:: PresentationFramework.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets the paginator for the FixedDocument that provides page-oriented services such as getting a particular page and repaginating in response to changes.

public:
 property System::Windows::Documents::DocumentPaginator ^ DocumentPaginator { System::Windows::Documents::DocumentPaginator ^ get(); };

public System.Windows.Documents.DocumentPaginator DocumentPaginator { get; }

member this.DocumentPaginator : System.Windows.Documents.DocumentPaginator

Public ReadOnly Property DocumentPaginator As DocumentPaginator

Property Value

DocumentPaginator

An object of a class derived from DocumentPaginator that provides pagination services.

Implements

DocumentPaginator

Examples

The following example shows how to create a FixedDocument that has a paginator configured for a particular page size.

// ------------------------ CreateFixedDocument -----------------------
/// <summary>
///   Creates an empty FixedDocument.</summary>
/// <returns>
///   An empty FixedDocument without any content.</returns>
private FixedDocument CreateFixedDocument()
{
    FixedDocument fixedDocument = new FixedDocument();
    fixedDocument.DocumentPaginator.PageSize = new Size(96 * 8.5, 96 * 11);
    return fixedDocument;
}

' ------------------------ CreateFixedDocument -----------------------
''' <summary>
'''   Creates an empty FixedDocument.</summary>
''' <returns>
'''   An empty FixedDocument without any content.</returns>
Private Function CreateFixedDocument() As FixedDocument
    Dim fixedDocument As New FixedDocument()
    fixedDocument.DocumentPaginator.PageSize = New Size(96 * 8.5, 96 * 11)
    Return fixedDocument
End Function

The following example also shows use of the DocumentPaginator property.

// ------------------------ CreateFixedDocument -----------------------
/// <summary>
///   Creates an empty FixedDocument.</summary>
/// <returns>
///   An empty FixedDocument without any content.</returns>
private FixedDocument CreateFixedDocument()
{
    FixedDocument fixedDocument = new FixedDocument();
    fixedDocument.DocumentPaginator.PageSize = new Size(96 * 8.5, 96 * 11);
    return fixedDocument;
}

' ------------------------ CreateFixedDocument -----------------------
''' <summary>
'''   Creates an empty FixedDocument.</summary>
''' <returns>
'''   An empty FixedDocument without any content.</returns>
Private Function CreateFixedDocument() As FixedDocument
    Dim fixedDocument As New FixedDocument()
    fixedDocument.DocumentPaginator.PageSize = New Size(96 * 8.5, 96 * 11)
    Return fixedDocument
End Function

Remarks

If you need a paginator with automatic repagination in responses to changes, such as adding content to the document, derive a class from DynamicDocumentPaginator which itself inherits from DocumentPaginator.

Applies to

Share via