ExportOptions.GetOptionVisibility(ExportOptionKind) Method

Gets the current visibility of the specified export option in the Print Preview.

Namespace: DevExpress.XtraPrinting

Assembly: DevExpress.Printing.v22.2.Core.dll

NuGet Packages: DevExpress.Printing.Core, DevExpress.Win.Dashboard.Design

Declaration

C#

public bool GetOptionVisibility(
    ExportOptionKind optionKind
)

VB.NET

Public Function GetOptionVisibility(
    optionKind As ExportOptionKind
) As Boolean

Parameters

Name	Type	Description
optionKind	ExportOptionKind	An ExportOptionKind enumeration value which specifies the export option whose visibility state is to be determined.

Returns

Type	Description
Boolean	true if the specified export option is visible; otherwise, false.

Remarks

To change the visibility of the specified export option, the ExportOptions.SetOptionVisibility or ExportOptions.SetOptionsVisibility methods should be used.

Example

This example illustrates how to hide some of the export options from a print preview by using the ExportOptions.SetOptionVisibility and ExportOptions.SetOptionsVisibility methods.

The following code hides some of the PDF-specific export options.

All available export options are listed in the ExportOptionKind enumeration.

C#

using System.Drawing;
using DevExpress.XtraPrinting;
// ...

private void Form1_Load(object sender, EventArgs e) {
    PrintingSystem ps = new PrintingSystem();
    documentViewer1.PrintingSystem = ps;

    // Draw a simple text brick.
    ps.Begin();
    ps.Graph.DrawString("Some Text", new RectangleF(0, 20, 200, 20));
    ps.End();

    // Obtain its Export options.
    ExportOptions options = ps.ExportOptions;

    // Hide the "Never Embedded Fonts" option, if required.
    if(options.GetOptionVisibility(ExportOptionKind.PdfNeverEmbeddedFonts) != false) {
        options.SetOptionVisibility(ExportOptionKind.PdfNeverEmbeddedFonts, false);
    }

    // Hide all Document Options for PDF export.
    options.SetOptionsVisibility(new ExportOptionKind[] { ExportOptionKind.PdfDocumentApplication,
        ExportOptionKind.PdfDocumentAuthor, ExportOptionKind.PdfDocumentKeywords,
        ExportOptionKind.PdfDocumentSubject, ExportOptionKind.PdfDocumentTitle}, false);            
}

VB.NET

Imports System.Drawing
Imports DevExpress.XtraPrinting
' ...

Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs)
    Dim ps As New PrintingSystem()
    documentViewer1.PrintingSystem = ps

    ' Draw a simple text brick.
    ps.Begin()
    ps.Graph.DrawString("Some Text", New RectangleF(0, 20, 200, 20))
    ps.End()

    ' Obtain its Export options.
    Dim options As ExportOptions = ps.ExportOptions

    ' Hide the "Never Embedded Fonts" option, if required.
    If options.GetOptionVisibility(ExportOptionKind.PdfNeverEmbeddedFonts) <> False Then
        options.SetOptionVisibility(ExportOptionKind.PdfNeverEmbeddedFonts, False)
    End If

    ' Hide all Document Options for PDF export.
    options.SetOptionsVisibility(New ExportOptionKind() { ExportOptionKind.PdfDocumentApplication, _
        ExportOptionKind.PdfDocumentAuthor, ExportOptionKind.PdfDocumentKeywords, ExportOptionKind.PdfDocumentSubject, _
        ExportOptionKind.PdfDocumentTitle}, False)
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GetOptionVisibility(ExportOptionKind) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

Reporting_how-to-hide-specific-export-options-in-the-print-preview-e5/CS/WindowsFormsApplication1/Form1.cs#L26

// Hide the "Never Embedded Fonts" option, if required.
if (options.GetOptionVisibility(ExportOptionKind.PdfNeverEmbeddedFonts) != false) {
    options.SetOptionVisibility(ExportOptionKind.PdfNeverEmbeddedFonts, false);

VB.NET

Reporting_how-to-hide-specific-export-options-in-the-print-preview-e5/VB/WindowsFormsApplication1/Form1.vb#L28

' Hide the "Never Embedded Fonts" option, if required.
If options.GetOptionVisibility(ExportOptionKind.PdfNeverEmbeddedFonts) <> False Then
    options.SetOptionVisibility(ExportOptionKind.PdfNeverEmbeddedFonts, False)