Version

WebExcelExporter Class Members

The following tables list the members exposed by WebExcelExporter.

Public Constructors
 NameDescription
Public ConstructorWebExcelExporter Constructor  
Public Properties
 NameDescription
Public PropertyAppRelativeTemplateSourceDirectoryGets or sets the application-relative virtual directory of the System.Web.UI.Page or System.Web.UI.UserControl object that contains this control. (Inherited from System.Web.UI.Control)
Public PropertyClientIDGets the control ID for HTML markup that is generated by ASP.NET. (Inherited from System.Web.UI.Control)
Public PropertyClientIDModeGets or sets the algorithm that is used to generate the value of the System.Web.UI.Control.ClientID property. (Inherited from System.Web.UI.Control)
Public PropertyControlsGets a System.Web.UI.ControlCollection object that represents the child controls for a specified server control in the UI hierarchy. (Inherited from System.Web.UI.Control)
Public PropertyDataExportModeDetermines whether the grid will export the entire set of data. (Inherited from Infragistics.Web.UI.GridControls.BaseExporter)
Public PropertyDisableCellValueFormattingDisables formatting of the cell value when grid BoundDataField or UnboundField has DataFormatString specified.  
Public PropertyDownloadNameFilename given to the document downloaded to the browser during export. (Inherited from Infragistics.Web.UI.GridControls.BaseExporter)
Public PropertyEnableStylesExportDetermines whether grid styles will be exported. This option is turned-on by default. (Inherited from Infragistics.Web.UI.GridControls.BaseExporter)
Public PropertyEnableThemingGets or sets a value indicating whether themes apply to this control. (Inherited from System.Web.UI.Control)
Public PropertyEnableViewStateGets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client. (Inherited from System.Web.UI.Control)
Public PropertyExportModeThe type of export mode - Download exports the file as attachment from the browser, InBrowser tries to open it inside the browser while Custom assumes that the developer would like to save /publish the exported file to a custom stream, object or location (Inherited from Infragistics.Web.UI.GridControls.BaseExporter)
Public PropertyGridsRowSpacingDetermines how many rows will be inserted between multiple grids when they are exported on a single worksheet. The default value is 1.  
Public PropertyIDGets or sets the programmatic identifier assigned to the server control. (Inherited from System.Web.UI.Control)
Public PropertyNamingContainerGets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same System.Web.UI.Control.ID property value. (Inherited from System.Web.UI.Control)
Public PropertyPageGets a reference to the System.Web.UI.Page instance that contains the server control. (Inherited from System.Web.UI.Control)
Public PropertyParentGets a reference to the server control's parent control in the page control hierarchy. (Inherited from System.Web.UI.Control)
Public PropertyRenderingCompatibilityGets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from System.Web.UI.Control)
Public PropertySiteGets information about the container that hosts the current control when rendered on a design surface. (Inherited from System.Web.UI.Control)
Public PropertySkinIDGets or sets the skin to apply to the control. (Inherited from System.Web.UI.Control)
Public PropertyTemplateControlGets or sets a reference to the template that contains this control. (Inherited from System.Web.UI.Control)
Public PropertyTemplateSourceDirectoryGets the virtual directory of the System.Web.UI.Page or System.Web.UI.UserControl that contains the current server control. (Inherited from System.Web.UI.Control)
Public PropertyUniqueIDGets the unique, hierarchically qualified identifier for the server control. (Inherited from System.Web.UI.Control)
Public PropertyValidateRequestModeGets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values. (Inherited from System.Web.UI.Control)
Public PropertyViewStateModeGets or sets the view-state mode of this control. (Inherited from System.Web.UI.Control)
Public PropertyVisibleGets or sets a value that indicates whether a server control is rendered as UI on the page. (Inherited from System.Web.UI.Control)
Public PropertyWorkbookFormatDetermines the format of the exported excel file.  
Protected Properties
 NameDescription
Protected PropertyAdapterGets the browser-specific adapter for the control. (Inherited from System.Web.UI.Control)
Protected PropertyChildControlsCreatedGets a value that indicates whether the server control's child controls have been created. (Inherited from System.Web.UI.Control)
Protected PropertyClientIDSeparatorGets a character value representing the separator character used in the System.Web.UI.Control.ClientID property. (Inherited from System.Web.UI.Control)
Protected PropertyDownloadExtensionOverridden. Returns the download extension for the workbook format being used  
Protected PropertyDownloadNameResolvedResolved download name. (Inherited from Infragistics.Web.UI.GridControls.BaseExporter)
Protected PropertyEventsGets a list of event handler delegates for the control. This property is read-only. (Inherited from System.Web.UI.Control)
Protected PropertyHasChildViewStateGets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from System.Web.UI.Control)
Protected PropertyIdSeparatorGets the character used to separate control identifiers. (Inherited from System.Web.UI.Control)
Protected PropertyIsTrackingViewStateGets a value that indicates whether the server control is saving changes to its view state. (Inherited from System.Web.UI.Control)
Protected PropertyLoadViewStateByIDGets a value indicating whether the control participates in loading its view state by System.Web.UI.Control.ID instead of index. (Inherited from System.Web.UI.Control)
Protected PropertyMimeTypeOverridden. Returns the MimeType that should be used for the file that's being exported.  
Protected PropertyUserAgentReturns a user agent (Inherited from Infragistics.Web.UI.GridControls.BaseExporter)
Protected PropertyViewStateGets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page. (Inherited from System.Web.UI.Control)
Protected PropertyViewStateIgnoresCaseGets a value that indicates whether the System.Web.UI.StateBag object is case-insensitive. (Inherited from System.Web.UI.Control)
Public Methods
 NameDescription
Public MethodApplyStyleSheetSkinApplies the style properties defined in the page style sheet to the control. (Inherited from System.Web.UI.Control)
Public MethodDataBindOverloaded. Binds a data source to the invoked server control and all its child controls. (Inherited from System.Web.UI.Control)
Public MethodDisposeDisposes of the BaseExporter (Inherited from Infragistics.Web.UI.GridControls.BaseExporter)
Public MethodExportOverloaded. Overridden. Exports a single flat grid.  
Public MethodFindControlOverloaded. Searches the current naming container for a server control with the specified id parameter. (Inherited from System.Web.UI.Control)
Public MethodFocusSets input focus to a control. (Inherited from System.Web.UI.Control)
Public MethodGetRouteUrlOverloaded. Gets the URL that corresponds to a set of route parameters. (Inherited from System.Web.UI.Control)
Public MethodGetUniqueIDRelativeToReturns the prefixed portion of the System.Web.UI.Control.UniqueID property of the specified control. (Inherited from System.Web.UI.Control)
Public MethodHasControlsDetermines if the server control contains any child controls. (Inherited from System.Web.UI.Control)
Public MethodRenderControlOverloaded. Outputs server control content to a provided System.Web.UI.HtmlTextWriter object and stores tracing information about the control if tracing is enabled. (Inherited from System.Web.UI.Control)
Public MethodResolveClientUrlGets a URL that can be used by the browser. (Inherited from System.Web.UI.Control)
Public MethodResolveUrlConverts a URL into one that is usable on the requesting client. (Inherited from System.Web.UI.Control)
Public MethodSetRenderMethodDelegateAssigns an event handler delegate to render the server control and its content into its parent control. (Inherited from System.Web.UI.Control)
Protected Methods
 NameDescription
Protected MethodAddParsedSubObjectNotifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's System.Web.UI.ControlCollection object. (Inherited from System.Web.UI.Control)
Protected MethodBuildProfileTreeGathers information about the server control and delivers it to the System.Web.UI.Page.Trace property to be displayed when tracing is enabled for the page. (Inherited from System.Web.UI.Control)
Protected MethodClearCachedClientIDSets the cached System.Web.UI.Control.ClientID value to a null reference (Nothing in Visual Basic). (Inherited from System.Web.UI.Control)
Protected MethodClearChildControlStateDeletes the control-state information for the server control's child controls. (Inherited from System.Web.UI.Control)
Protected MethodClearChildStateDeletes the view-state and control-state information for all the server control's child controls. (Inherited from System.Web.UI.Control)
Protected MethodClearChildViewStateDeletes the view-state information for all the server control's child controls. (Inherited from System.Web.UI.Control)
Protected MethodClearEffectiveClientIDModeSets the System.Web.UI.Control.ClientIDMode property of the current control instance and of any child controls to System.Web.UI.ClientIDMode.Inherit. (Inherited from System.Web.UI.Control)
Protected MethodCreateControlCollectionCreates a new System.Web.UI.ControlCollection object to hold the child controls (both literal and server) of the server control. (Inherited from System.Web.UI.Control)
Protected MethodDataBindChildrenBinds a data source to the server control's child controls. (Inherited from System.Web.UI.Control)
Protected MethodDownloadDocumentstreams the file to the browser as attachment (Inherited from Infragistics.Web.UI.GridControls.BaseExporter)
Protected MethodDownloadWorkbookDownloads the work book to the browser  
Protected MethodEnsureChildControlsDetermines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from System.Web.UI.Control)
Protected MethodEnsureIDCreates an identifier for controls that do not have an identifier assigned. (Inherited from System.Web.UI.Control)
Protected MethodExportCellExports a grid record item to its corresponding worksheet cell.  
Protected MethodExportGridExports a single flat grid to the specified worksheet. Exporting starts from the defined rowIndex and columnOffset. The rowIndex is updated to point after the last exported row.  
Protected MethodExportGridFieldCaptionExports a grid field caption (header or footer) to the specified worksheet cell.  
Protected MethodExportGroupedRowsExports set of grouped rows to the specified worksheet.  
Protected MethodExportHierarchicalGridExports a single hierarchical grid to the specified worksheet. Exporting starts from the defined rowIndex and columnOffset. The rowIndex is updated to point after the last exported row.  
Protected MethodExportRowExports a single grid row to the specified worksheet.  
Protected MethodExportRowIslandsExports a set of row islands to the specified worksheet.  
Protected MethodExportSummariesExports grid SummaryRow to the specified worksheet.  
Protected MethodGetDesignModeStateGets design-time data for a control. (Inherited from System.Web.UI.Control)
Protected MethodGetExcelFunctionNameTakes a SummaryType as an argument and returns the corresponding Excel function name. Returns null for SummaryType.Custom.  
Protected MethodGetWidestLineLengthGets the width in characters of a multi-line cell's value.  
Protected MethodHasEventsReturns a value indicating whether events are registered for the control or any child controls. (Inherited from System.Web.UI.Control)
Protected MethodIsLiteralContentDetermines if the server control holds only literal content. (Inherited from System.Web.UI.Control)
Protected MethodLoadLinkedStylesResolves application styling stylesheets. (Inherited from Infragistics.Web.UI.GridControls.BaseExporter)
Protected MethodLoadPageStylesResolves Page styles. (Inherited from Infragistics.Web.UI.GridControls.BaseExporter)
Protected MethodLoadViewStateRestores view-state information from a previous page request that was saved by the System.Web.UI.Control.SaveViewState method. (Inherited from System.Web.UI.Control)
Protected MethodOnBubbleEventDetermines whether the event for the server control is passed up the page's UI server control hierarchy. (Inherited from System.Web.UI.Control)
Protected MethodOnCellExportedRaises the Cell Exported Event.  
Protected MethodOnCellExportingRaises the Cell Exporting Event.  
Protected MethodOnDataBindingRaises the System.Web.UI.Control.DataBinding event. (Inherited from System.Web.UI.Control)
Protected MethodOnExportedRaises the Exported Event.  
Protected MethodOnExportingRaises the Exporting Event.  
Protected MethodOnGridFieldCaptionExportedRaises the GridFieldCaptionExported Event.  
Protected MethodOnGridFieldCaptionExportingRaises the GridFieldCaptionExporting Event.  
Protected MethodOnGridRecordItemExportedRaises the GridRecordItemExported Event.  
Protected MethodOnGridRecordItemExportingRaises the GridRecordItemExporting Event.  
Protected MethodOnRowExportedRaises the Row Exported Event.  
Protected MethodOnRowExportingRaises the Row Exporting Event.  
Protected MethodOnSummaryCellExportedRaises the SummaryCellExported Event.  
Protected MethodOnSummaryCellExportingRaises the SummaryCellExporting Event.  
Protected MethodRaiseBubbleEventAssigns any sources of the event and its information to the control's parent. (Inherited from System.Web.UI.Control)
Protected MethodRebindToAllDataWill disable virtual scrolling and paging if all of the data should be shown (Inherited from Infragistics.Web.UI.GridControls.BaseExporter)
Protected MethodRenderTemplateRenders the specified TemplateContainer to string and returns the value.  
Protected MethodResolveAdapterGets the control adapter responsible for rendering the specified control. (Inherited from System.Web.UI.Control)
Protected MethodRestoreBindingRestores the orignal enabled values of virtual scrolling and paging on a grid (Inherited from Infragistics.Web.UI.GridControls.BaseExporter)
Protected MethodSaveViewStateSaves any server control view-state changes that have occurred since the time the page was posted back to the server. (Inherited from System.Web.UI.Control)
Protected MethodSetDesignModeStateSets design-time data for a control. (Inherited from System.Web.UI.Control)
Protected MethodTrackViewStateCauses tracking of view-state changes to the server control so they can be stored in the server control's System.Web.UI.StateBag object. This object is accessible through the System.Web.UI.Control.ViewState property. (Inherited from System.Web.UI.Control)
Public Events
 NameDescription
Public EventCellExportedOccurs when cell exporting is complete. This event is obsolete. Use GridFieldCaptionExported, GridRecordItemExported, SummaryCellExported instead.  
Public EventCellExportingOccurs before cell exporting start. This event is obsolete. Use GridFieldCaptionExporting, GridRecordItemExporting, SummaryCellExporting instead.  
Public EventDataBindingOccurs when the server control binds to a data source. (Inherited from System.Web.UI.Control)
Public EventDisposedOccurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested. (Inherited from System.Web.UI.Control)
Public EventExportedOccurs when exporting is complete.  
Public EventExportingOccurs before the exporting start.  
Public EventGridFieldCaptionExportedOccurs when grid field caption exporting is complete.  
Public EventGridFieldCaptionExportingOccurs before grid field caption item exporting starts.  
Public EventGridRecordItemExportedOccurs when grid record item exporting is complete.  
Public EventGridRecordItemExportingOccurs before grid record item exporting starts.  
Public EventInitOccurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from System.Web.UI.Control)
Public EventLoadOccurs when the server control is loaded into the System.Web.UI.Page object. (Inherited from System.Web.UI.Control)
Public EventPreRenderOccurs after the System.Web.UI.Control object is loaded but prior to rendering. (Inherited from System.Web.UI.Control)
Public EventRowExportedOccurs when row exporting is complete.  
Public EventRowExportingOccurs before row exporting start.  
Public EventSummaryCellExportedOccurs when summary cell exporting is complete.  
Public EventSummaryCellExportingOccurs before summary cell exporting starts.  
Public EventUnloadOccurs when the server control is unloaded from memory. (Inherited from System.Web.UI.Control)
See Also