PdfViewer.IsVisible(PdfDocumentPosition) Method

Indicates the current visibility of a specific PdfDocumentPosition.

Namespace: DevExpress.XtraPdfViewer

Assembly: DevExpress.XtraPdfViewer.v20.2.dll

Declaration

public bool IsVisible(
    PdfDocumentPosition documentPosition
)
Public Function IsVisible(
    documentPosition As PdfDocumentPosition
) As Boolean

Parameters

Name Type Description
documentPosition PdfDocumentPosition

A PdfDocumentPosition object that contains information about a specific document's position.

Returns

Type Description
Boolean

true, if a specific PDF document position is visible; otherwise, false.

Remarks

When calling the IsVisible method with the document position being null, the ArgumentNullException will be thrown.

When you call the IsVisible method before any document has been loaded, an InvalidOperationException will be thrown.

If the document position is found to be not visible, call the PdfViewer.EnsureVisibility method. This method tries to display the document position at the center of the screen using the current document zoom factor. If this is not possible, the displayed position will appear within the visible document area.

See Also