Xceed Logo
Shop
Xceed Grid for WinForms v4.3 Documentation
Xceed.Grid.v4.3 Assembly / Xceed.Grid.Reporting Namespace / ReportSettings Class
Members


In This Topic
    ReportSettings Class
    In This Topic
    Class which represents the report settings of a Xceed.Grid.GridControl.
    Syntax
    'Declaration
 
Public Class ReportSettings 
    'Usage
 
Dim instance As ReportSettings
    public class ReportSettings
    Remarks

    The report settings constitute various parameters of a report that generally are specific to a grid; that have no place in a ReportStyleSheet or ReportStyle instance. Usually a user would want these settings saved each time he prints a report with a specific grid. This saving feature is the default behavior of ReportSettings.

    Inheritance Hierarchy

    System.Object
       Xceed.Grid.Reporting.ReportSettings

    Public Properties
     NameDescription
    Public PropertyColorGets or sets a boolean value indicating if the report should be printed in color.  
    Public PropertyColumnLayoutGets or sets a value indicating how columns which surpass the available page width are printed in a report.  
    Public PropertyCustomVariablesGets a dictionary of case-insensitive custom variables.  
    Public Propertystatic (Shared in Visual Basic)DefaultPathGets or sets the default path from which the XML files containing the report settings are saved and loaded.  
    Public PropertyIsColorDefinedGets a boolean value indicating if the Color property has been explicitly set.  
    Public PropertyIsColumnLayoutDefinedGets a boolean value indicating if the ColumnLayout property has been explicitly set.  
    Public PropertyIsLandscapeDefinedGets a boolean value indicating if the Landscape property has been explicitly set.  
    Public PropertyIsMarginsDefinedGets a boolean value indicating if the Margins property has been explicitly set.  
    Public PropertyIsPaperSizeDefinedGets a boolean value indicating if the PaperSize property has been explicitly set.  
    Public PropertyIsPaperSourceNameDefinedGets a boolean value indicating if the PaperSourceName property has been explicitly set.  
    Public PropertyIsPrinterNameDefinedGets a boolean value indicating if the PrinterName property has been explicitly set.  
    Public PropertyIsTitleDefinedGets a boolean value indicating if the Title property has been explicitly set.  
    Public PropertyLandscapeGets or sets a boolean value indicating if the report should be printed in landscape orientation.  
    Public PropertyMarginsGets or sets the margins of the printed report.  
    Public PropertyPaperSizeGets or sets the size of the paper on which the report will be printed.  
    Public PropertyPaperSourceGets the paper tray from which the printer gets paper.  
    Public PropertyPaperSourceNameGets or sets the name of the paper source.  
    Public PropertyPersistedColumnPropertiesGets a collection containing the case-sensitive names of the ColumnReportStyle properties that will be saved when the Save method is called, and loaded when the Load method is called.  
    Public PropertyPersistedSettingsGets the case-sensitive  names of the properties of the ReportSettings that will be persisted with the grid and saved or loaded when the Save or Load methods are called.  
    Public PropertyPrinterNameGets or sets the name of the printer on which to print the report.  
    Public PropertyTitleGets or sets the title of the report.  
    Top
    Public Methods
     NameDescription
    Public MethodLoadOverloaded. Loads the report settings from the XML file contained in the DefaultPath.  
    Public MethodResetColorResets the value of the Color property to its default value, false.  
    Public MethodResetColumnLayoutResets the value of the ColumnLayout property to its default value, ColumnLayout.SpanAcrossPages.  
    Public Methodstatic (Shared in Visual Basic)ResetDefaultPathResets the value of the DefaultPath property to its default value, System.Windows.Forms.Application.LocalUserAppDataPath.  
    Public MethodResetLandscapeResets the value of the Landscape property to its default value, false.  
    Public MethodResetMarginsResets the value of the Margins property to its default value, a null reference (Nothing in Visual Basic).  
    Public MethodResetPaperSizeResets the value of the PaperSize property to its default value, a null reference (Nothing in Visual Basic).  
    Public MethodResetPaperSourceNameResets the value of the PaperSourceName property to its default value, a null reference (Nothing in Visual Basic).  
    Public MethodResetPrinterNameResets the value of the PrinterName property to its default value.  
    Public MethodResetTitleResets the value of the Title property to its default value, Xceed.Grid.GridControl.Title.  
    Public MethodSaveOverloaded. Saves the values of the properties specified by the PersistedColumnProperties and PersistedSettings properties to a file in the DefaultPath.  
    Top
    Requirements

    Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also

    Reference

    ReportSettings Members
    Xceed.Grid.Reporting Namespace

    Send Feedback