PdfExportSettings Class

Spotfire 14.3 API Reference

Note: This API is now obsolete.

Settings used when exporting to PDF.
Inheritance Hierarchy

SystemObject
  Spotfire.Dxp.Application.ExportExportSettings
    Spotfire.Dxp.Application.ExportPdfExportSettings

Namespace:  Spotfire.Dxp.Application.Export
Assembly:  Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 65.0.19510.3242 (65.0.19510.3242)
Syntax

C#
[ObsoleteAttribute("Use Report.Export() to export a PDF from the analysis. Enumerate reports using the Document.GetReports() method.")]
public sealed class PdfExportSettings : ExportSettings

The PdfExportSettings type exposes the following members.

Constructors

  NameDescription
Public methodPdfExportSettings
Initializes a new instance of the PdfExportSettings class.
Top
Properties

  NameDescription
Public propertyIncludeFilterSettings
Gets or sets a value indicating whether to include filter settings or not. Default value: True.
(Inherited from ExportSettings.)
Public propertyIncludeNonVisibleContent
Gets or sets a value indicating whether to include non-visible content, e.g. trellis panels and complete tables. This is not applicable when exporting active page or all pages. Default value: False.
(Inherited from ExportSettings.)
Public propertyIncludePageFooter
Gets or sets a value indicating whether to include page footers or not. Default value: False.
(Inherited from ExportSettings.)
Public propertyIncludePageTitles
Gets or sets a value indicating whether to include page titles or not. Default value: True.
(Inherited from ExportSettings.)
Public propertyIncludeVisualizationDescriptions
Gets or sets a value indicating whether to include visualization descriptions or not. Default value: False.
(Inherited from ExportSettings.)
Public propertyIncludeVisualizationTitles
Gets or sets a value indicating whether to include visualization titles or not. Default value: True.
(Inherited from ExportSettings.)
Public propertyPageFooter
Gets or sets the text in the page footer.
(Inherited from ExportSettings.)
Public propertyPageOrientation
Gets or sets the page orientation. Default value: Landscape.
Public propertyPaperSize
Gets or sets the paper size. Default value: Letter.
Public propertyScope
Gets or sets the scope of the export. Default value: ActivePage.
(Inherited from ExportSettings.)
Public propertyUseEntirePage
Gets or sets a value indicating whether the entire page should be used. If True, the aspect ratio is not kept. Default value: False.
(Inherited from ExportSettings.)
Top
Methods

  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Version Information

Obsolete (compiler warning) in 14.3
Obsolete (compiler warning) in 14.2
Obsolete (compiler warning) in 14.1
Obsolete (compiler warning) in 14.0
Obsolete (compiler warning) in 12.5
Obsolete (compiler warning) in 12.4
Obsolete (compiler warning) in 12.3
Obsolete (compiler warning) in 12.2
Obsolete (compiler warning) in 12.1
Obsolete (compiler warning) in 12.0
Obsolete (compiler warning) in 11.8
See Also

Reference