Xceed Logo
Shop
Xceed Grid for WinForms v4.3 Documentation
Xceed.Grid.v4.3 Assembly / Xceed.Grid.Exporting Namespace / ExcelExporter Class
Members


In This Topic
    ExcelExporter Class
    In This Topic
    The ExcelExporter class allows data from a Xceed.Grid.GridControl to be exported as a spreadsheet in XML format, suitable for import into Microsoft Excel.
    Syntax
    'Declaration
 
Public Class ExcelExporter 
    'Usage
 
Dim instance As ExcelExporter
    public class ExcelExporter
    Inheritance Hierarchy

    System.Object
       Xceed.Grid.Exporting.ExcelExporter

    Public Constructors
     NameDescription
    Public ConstructorExcelExporter Constructor  
    Top
    Public Properties
     NameDescription
    Public PropertyCellDataFormatGets or sets an CellDataFormat value representing how the content of a cell is treated.  
    Public PropertyColumnHeaderStyleGets or sets the style of the column header.  
    Public PropertyCustomStylesGets a list of custom styles.  
    Public PropertyDetailGridsModeGets or sets the mode used to determine how detail grids are presented in the exported grid.  
    Public PropertyGridLineColorGets or sets the color of the spreadsheet's grid lines.  
    Public PropertyIncludeColumnHeadersGets or sets a boolean value indicating whether column headers are to be included in the exported grid.  
    Public PropertyIncludeDetailGridsGets or sets a boolean value indicating whether detail grids are to be included in the exported grid.  
    Public PropertyIncludeGridStylesGets or sets a boolean value indicating whether the styles of the GridControl whose data is to be exported should be used in the exported spreadsheet.  
    Public PropertyRepeatParentDataGets or sets a boolean value indicating whether parent data rows should be repeated with every child row in the exported grid.  
    Top
    Protected Properties
     NameDescription
    Protected PropertyDefaultCellDataFormatGets the default value of the CellDataFormat property  
    Protected PropertyDefaultColumnHeaderStyleGets the default value of the ColumnHeaderStyle property  
    Protected PropertyDefaultDetailGridsModeGets the default value of the DetailGridsMode property.  
    Protected PropertyDefaultGridLineColorGets the default value of the GridLineColor property.  
    Protected PropertyDefaultIncludeColumnHeadersGets the default value of the IncludeColumnHeaders property.  
    Protected PropertyDefaultIncludeDetailGridsGets the default value of the IncludeDetailGrids property.  
    Protected PropertyDefaultIncludeGridStylesGets the default value of the IncludeGridStyles property.  
    Protected PropertyDefaultRepeatParentDataGets the default value of the RepeatParentData property.  
    Protected PropertyEventsGets a list of the events to which the grid element is subscribed.  
    Protected PropertyPropertiesGets a collection of property names whose values have been explicitly set as well as the corresponding values.  
    Top
    Public Methods
     NameDescription
    Public MethodExportOverloaded. Exports the data of a Xceed.Grid.GridControl to a spreadsheet in XML suitable for import into Microsoft Excel.  
    Public MethodResetCellDataFormatResets the value of the CellDataFormat property to its default value, DefaultCellDataFormat.  
    Public MethodResetColumnHeaderStyleResets the value of the ColumnHeaderStyle property to its default value, DefaultColumnHeaderStyle.  
    Public MethodResetDetailGridsModeResets the value of the DetailGridsMode property to its default value, DefaultDetailGridsMode.  
    Public MethodResetGridLineColorResets the value of the GridLineColor property to its default value, DefaultGridLineColor.  
    Public MethodResetIncludeColumnHeadersResets the value of the IncludeColumnHeaders property to its default value, DefaultIncludeColumnHeaders.  
    Public MethodResetIncludeDetailGridsResets the value of the IncludeDetailGrids property to its default value, DefaultIncludeDetailGrids.  
    Public MethodResetIncludeGridStylesResets the value of the IncludeGridStyles property to its default value, DefaultIncludeGridStyles.  
    Public MethodResetRepeatParentDataResets the value of the RepeatParentData property to its default value, DefaultRepeatParentData.  
    Top
    Protected Methods
     NameDescription
    Protected MethodGetPropertyValueRetrieves the value of the specified property in the Properties collection.  
    Protected MethodIsPropertyDefinedRetrieves a boolean value indicating if the specified property has been explicitly set.  
    Protected MethodOnCellDataFormatChangedRaises the CellDataFormatChanged event.  
    Protected MethodOnColumnHeaderStyleChangedRaises the ColumnHeaderStyleChanged event.  
    Protected MethodOnDetailGridsModeChangedRaises the DetailGridsModeChanged event.  
    Protected MethodOnGridLineColorChangedRaises the GridLineColorChanged event.  
    Protected MethodOnIncludeColumnHeadersChangedRaises the IncludeColumnHeadersChanged event.  
    Protected MethodOnIncludeDetailGridsChangedRaises the IncludeDetailGridsChanged event.  
    Protected MethodOnIncludeGridStylesChangedRaises the IncludeGridStylesChanged event.  
    Protected MethodOnRepeatParentDataChangedRaises the RepeatParentDataChanged event.  
    Protected MethodOnWritingCellRaises the WritingCell event.  
    Protected MethodOnWritingColumnRaises the WritingColumn event.  
    Protected MethodOnWritingRowRaises the WritingRow event.  
    Protected MethodOnWritingTableRaises the WritingTable event.  
    Protected MethodOnWritingWorkbookRaises the WritingWorkbook event.  
    Protected MethodOnWritingWorksheetRaises the WritingWorksheet event.  
    Protected MethodRaiseEventRaises the specified event.  
    Protected MethodRemovePropertyValueRemoves the specified property from the Properties collection.  
    Top
    Public Events
     NameDescription
    Public EventCellDataFormatChangedRaised when the value of the CellDataFormat property is changed.  
    Public EventColumnHeaderStyleChangedRaised when the value of the ColumnHeaderStyle property is changed.  
    Public EventDetailGridsModeChangedRaised when the value of the DetailGridsMode property is changed.  
    Public EventGridLineColorChangedRaised when the value of the GridLineColor property is changed.  
    Public EventIncludeColumnHeadersChangedRaised when the value of the IncludeColumnHeaders property is changed.  
    Public EventIncludeDetailGridsChangedRaised when the value of the IncludeDetailGrids property is changed.  
    Public EventIncludeGridStylesChangedRaised when the value of the IncludeGridStyles property is changed.  
    Public EventRepeatParentDataChangedRaised when the value of the RepeatParentData property is changed.  
    Public EventWritingCellRaised when a Cell element is being written.  
    Public EventWritingColumnRaised when a Column element is being written.  
    Public EventWritingRowRaised when a Row element is being written.  
    Public EventWritingTableRaised when a Table element is being written.  
    Public EventWritingWorkbookRaised when a Workbook element is being written.  
    Public EventWritingWorksheetRaised when a Worksheet element is being written  
    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

    ExcelExporter Members
    Xceed.Grid.Exporting Namespace

    Send Feedback