SpreadsheetWebControl Class
Free Trial Web API version Licensing Request A Quote
HAVE QUESTIONS OR NEED HELP?SUBMIT THE SUPPORT REQUEST FORM or write email toSUPPORT@BYTESCOUT.COM
Spreadsheet web control
Inheritance Hierarchy
System.Web.UIControl
System.Web.UI.WebControlsWebControl
Bytescout.SpreadsheetSpreadsheetWebControl
Namespace:Bytescout.Spreadsheet
Assembly: Bytescout.Spreadsheet (in Bytescout.Spreadsheet.dll) Version: 4.7.0.2045-master
Syntax
The SpreadsheetWebControl type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | SpreadsheetWebControl | Initializes a new instance of the SpreadsheetWebControl class |
Properties
| Name | Description | |
|---|---|---|
 | AccessKey | Gets or sets the access key that allows you to quickly navigate to the Web server control. (Inherited from WebControl.) |
 | Adapter | Gets the browser-specific adapter for the control. (Inherited from Control.) |
| AppRelativeTemplateSourceDirectory | Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control.) |
| Attributes | Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. (Inherited from WebControl.) |
| BackColor | Gets or sets the background color of the Web server control. (Inherited from WebControl.) |
| BindingContainer | Gets the control that contains this control's data binding. (Inherited from Control.) |
| BorderColor | Gets or sets the border color of the Web control. (Inherited from WebControl.) |
| BorderStyle | Gets or sets the border style of the Web server control. (Inherited from WebControl.) |
| BorderWidth | Gets or sets the border width of the Web server control. (Inherited from WebControl.) |
| Cache | Sets the cache type. |
| ChildControlsCreated | Gets a value that indicates whether the server control's child controls have been created. (Inherited from Control.) |
| ClientID | Gets the server control identifier generated by ASP.NET. (Inherited from Control.) |
| ClientIDMode | (Inherited from Control.) |
| ClientIDSeparator | Gets a character value representing the separator character used in the ClientID property. (Inherited from Control.) |
| Context | Gets the HttpContext object associated with the server control for the current Web request. (Inherited from Control.) |
| Controls | Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy. (Inherited from Control.) |
| ControlStyle | Gets the style of the Web server control. This property is used primarily by control developers. (Inherited from WebControl.) |
| ControlStyleCreated | Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers. (Inherited from WebControl.) |
| CssClass | Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. (Inherited from WebControl.) |
| DataItemContainer | (Inherited from Control.) |
| DataKeysContainer | (Inherited from Control.) |
| DesignMode | Gets a value indicating whether a control is being used on a design surface. (Inherited from Control.) |
| Enabled | Gets or sets a value indicating whether the Web server control is enabled. (Inherited from WebControl.) |
| EnableTheming | Gets or sets a value indicating whether themes apply to this control. (Inherited from WebControl.) |
| EnableViewState | Gets 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 Control.) |
| Events | Gets a list of event handler delegates for the control. This property is read-only. (Inherited from Control.) |
| Font | Gets the font properties associated with the Web server control. (Inherited from WebControl.) |
| ForeColor | Gets or sets the foreground color (typically the color of the text) of the Web server control. (Inherited from WebControl.) |
| HasAttributes | Gets a value indicating whether the control has attributes set. (Inherited from WebControl.) |
| HasChildViewState | Gets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control.) |
| Height | Gets or sets the height of the Web server control. (Inherited from WebControl.) |
| ID | Gets or sets the programmatic identifier assigned to the server control. (Inherited from Control.) |
| IdSeparator | Gets the character used to separate control identifiers. (Inherited from Control.) |
| IsChildControlStateCleared | Gets a value indicating whether controls contained within this control have control state. (Inherited from Control.) |
| IsEnabled | Gets a value indicating whether the control is enabled. (Inherited from WebControl.) |
| IsTrackingViewState | Gets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control.) |
| IsViewStateEnabled | Gets a value indicating whether view state is enabled for this control. (Inherited from Control.) |
| LoadViewStateByID | Gets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control.) |
| NamingContainer | Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same ID property value. (Inherited from Control.) |
| Options | Gets the options. |
| Page | Gets a reference to the Page instance that contains the server control. (Inherited from Control.) |
| Parent | Gets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control.) |
| RenderingCompatibility | (Inherited from Control.) |
| Site | Gets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control.) |
| SkinID | Gets or sets the skin to apply to the control. (Inherited from WebControl.) |
| Style | Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control. (Inherited from WebControl.) |
| SupportsDisabledAttribute | (Inherited from WebControl.) |
| TabIndex | Gets or sets the tab index of the Web server control. (Inherited from WebControl.) |
| TagKey | Gets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers. (Inherited from WebControl.) |
| TagName | Gets the name of the control tag. This property is used primarily by control developers. (Inherited from WebControl.) |
| TemplateControl | Gets or sets a reference to the template that contains this control. (Inherited from Control.) |
| TemplateSourceDirectory | Gets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control.) |
| ToolTip | Gets or sets the text displayed when the mouse pointer hovers over the Web server control. (Inherited from WebControl.) |
| UniqueID | Gets the unique, hierarchically qualified identifier for the server control. (Inherited from Control.) |
| UserKey | Gets or sets the key number part of registration information. |
| UserName | Gets or sets the name part of the registration information. |
| ValidateRequestMode | (Inherited from Control.) |
| ViewState | Gets 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 Control.) |
| ViewStateIgnoresCase | Gets a value that indicates whether the StateBag object is case-insensitive. (Inherited from Control.) |
| ViewStateMode | (Inherited from Control.) |
| Visible | Gets or sets a value that indicates whether a server control is rendered as UI on the page. (Inherited from Control.) |
| Width | Gets or sets the width of the Web server control. (Inherited from WebControl.) |
| Workbook | Gets or sets the Workbook. |
Methods
| Name | Description | |
|---|---|---|
 | AddAttributesToRender | Adds HTML attributes and styles that need to be rendered to the specified HtmlTextWriterTag. This method is used primarily by control developers. (Inherited from WebControl.) |
| AddedControl | Called after a child control is added to the Controls collection of the Control object. (Inherited from Control.) |
| AddParsedSubObject | Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object. (Inherited from Control.) |
| ApplyStyle | Copies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers. (Inherited from WebControl.) |
| ApplyStyleSheetSkin | Applies the style properties defined in the page style sheet to the control. (Inherited from Control.) |
| BeginRenderTracing | (Inherited from Control.) |
| BuildProfileTree | Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page. (Inherited from Control.) |
| ClearCachedClientID | (Inherited from Control.) |
| ClearChildControlState | Deletes the control-state information for the server control's child controls. (Inherited from Control.) |
| ClearChildState | Deletes the view-state and control-state information for all the server control's child controls. (Inherited from Control.) |
| ClearChildViewState | Deletes the view-state information for all the server control's child controls. (Inherited from Control.) |
| ClearEffectiveClientIDMode | (Inherited from Control.) |
| Close | Closes this instance. |
| CopyBaseAttributes | Copies the properties not encapsulated by the Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers. (Inherited from WebControl.) |
| CreateChildControls | Called by the ASP.NET page framework to notify server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering. (Inherited from Control.) |
| CreateControlCollection | Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control. (Inherited from Control.) |
| CreateControlStyle | Creates the style object that is used internally by the WebControl class to implement all style related properties. This method is used primarily by control developers. (Inherited from WebControl.) |
| DataBind | Binds a data source to the invoked server control and all its child controls. (Inherited from Control.) |
| DataBind(Boolean) | Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event. (Inherited from Control.) |
| DataBindChildren | Binds a data source to the server control's child controls. (Inherited from Control.) |
| Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. |
| EndRenderTracing | (Inherited from Control.) |
| EnsureChildControls | Determines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from Control.) |
| EnsureID | Creates an identifier for controls that do not have an identifier assigned. (Inherited from Control.) |
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| Finalize | Releases unmanaged resources and performs other cleanup operations before theSpreadsheet is reclaimed by garbage collection. (Overrides ObjectFinalize.) |
| FindControl(String) | Searches the current naming container for a server control with the specified id parameter. (Inherited from Control.) |
| FindControl(String, Int32) | Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the FindControl method. (Inherited from Control.) |
| Focus | Sets input focus to a control. (Inherited from Control.) |
| GetAsBytesArray | Gets the bytes of spreadsheet saved as document with specified type. |
| GetAsBytesArrayCSV | Gets the bytes of spreadsheet saved as CSV document. |
| GetAsBytesArrayHTML | Gets the bytes of spreadsheet saved as HTML document. |
| GetAsBytesArrayHTML(Int32) | Gets the bytes of specified worksheet page saved as HTML document. |
| GetAsBytesArrayTXT | Gets the bytes of spreadsheet saved as text document. |
| GetAsBytesArrayXLS | Gets the bytes of spreadsheet saved as XLS document. |
| GetAsBytesArrayXLSX | Gets the bytes of spreadsheet saved as XLSX document. |
| GetAsBytesArrayXML | Gets the bytes of spreadsheet saved as XML document. |
| GetDesignModeState | Gets design-time data for a control. (Inherited from Control.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetRouteUrl(Object) | (Inherited from Control.) |
| GetRouteUrl(RouteValueDictionary) | (Inherited from Control.) |
| GetRouteUrl(String, Object) | (Inherited from Control.) |
| GetRouteUrl(String, RouteValueDictionary) | (Inherited from Control.) |
| GetType | Gets the type of the current instance. (Inherited from Object.) |
| GetUniqueIDRelativeTo | (Inherited from Control.) |
| HasControls | Determines if the server control contains any child controls. (Inherited from Control.) |
| HasEvents | Returns a value indicating whether events are registered for the control or any child controls. (Inherited from Control.) |
| IsLiteralContent | Determines if the server control holds only literal content. (Inherited from Control.) |
| LoadControlState | Restores control-state information from a previous page request that was saved by the SaveControlState method. (Inherited from Control.) |
| LoadFromFile(String) | Load data from file. |
| LoadFromFile(String, CacheType) | Load data from file. |
| LoadFromFile(String, String) | Load data from file. |
| LoadFromFile(String, CacheType, String) | Load data from file. |
| LoadFromFile(String, String, Encoding) | Load data from file. |
| LoadFromFile(String, CacheType, String, Encoding) | Load data from file. |
| LoadFromFile(String, CacheType, String, Encoding, String) | Load data from file. |
| LoadFromStream(Stream) | Load data from stream. |
| LoadFromStream(Stream, CacheType) | Load data from stream. |
| LoadFromStream(Stream, SpreadsheetFormatType) | Load data from stream. |
| LoadFromStream(Stream, SpreadsheetFormatType, CacheType) | Load data from stream. |
| LoadFromStream(Stream, SpreadsheetFormatType, String, Encoding) | Load data from stream. |
| LoadFromStream(Stream, SpreadsheetFormatType, CacheType, String, Encoding) | Load data from stream. |
| LoadViewState | Restores view-state information from a previous request that was saved with the SaveViewState method. (Inherited from WebControl.) |
| MapPathSecure | Retrieves the physical path that a virtual path, either absolute or relative, maps to. (Inherited from Control.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| MergeStyle | Copies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers. (Inherited from WebControl.) |
| OnBubbleEvent | Determines whether the event for the server control is passed up the page's UI server control hierarchy. (Inherited from Control.) |
| OnDataBinding | Raises the DataBinding event. (Inherited from Control.) |
| OnInit | Raises the Init event. (Inherited from Control.) |
| OnLoad | Raises the Load event. (Inherited from Control.) |
| OnPreRender | Raises the PreRender event. (Inherited from Control.) |
| OnUnload | Raises the Unload event. (Inherited from Control.) |
| OpenFile | Gets a Stream used to read a file. (Inherited from Control.) |
| RaiseBubbleEvent | Assigns any sources of the event and its information to the control's parent. (Inherited from Control.) |
| RemovedControl | Called after a child control is removed from the Controls collection of the Control object. (Inherited from Control.) |
| Render | Renders the control to the specified HTML writer. (Inherited from WebControl.) |
| RenderBeginTag | Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers. (Overrides WebControlRenderBeginTag(HtmlTextWriter).) |
| RenderChildren | Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client. (Inherited from Control.) |
| RenderContents | Renders the contents. (Overrides WebControlRenderContents(HtmlTextWriter).) |
| RenderControl(HtmlTextWriter) | Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. (Inherited from Control.) |
| RenderControl(HtmlTextWriter, ControlAdapter) | Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. (Inherited from Control.) |
| RenderEndTag | Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers. (Overrides WebControlRenderEndTag(HtmlTextWriter).) |
| ResolveAdapter | Gets the control adapter responsible for rendering the specified control. (Inherited from Control.) |
| ResolveClientUrl | Gets a URL that can be used by the browser. (Inherited from Control.) |
| ResolveUrl | Converts a URL into one that is usable on the requesting client. (Inherited from Control.) |
| SaveAs(String) | Saves data in XLS or XLSX file FileName |
| SaveAs(String, SpreadsheetFormatType) | Saves data in XLS or XLSX file FileName |
| SaveAsCSV | Saves data in CSV file with specified name |
| SaveAsHTML(String) | Saves spreadsheet in a HTML format file. The second and subsequent worksheets of the spreadsheet will be saved in separate files with auto-generated names. |
| SaveAsHTML(String, Boolean) | Saves spreadsheet in a HTML format file. The second and subsequent worksheets of the spreadsheet will be saved in separate files with auto-generated names. |
| SaveAsTXT | Saves data in TXT file with specified name |
| SaveAsXLS | Saves data in XLS file with specified name |
| SaveAsXLSX | Saves data in XLSX format to a file with specified name |
| SaveAsXML | Saves data in XML file with specified name |
| SaveControlState | Saves any server control state changes that have occurred since the time the page was posted back to the server. (Inherited from Control.) |
| SaveToStream(Stream) | Saves data in XLS format to a given stream |
| SaveToStream(Stream, SpreadsheetFormatType) | Saves data in XLS or XLSX format to a given stream |
| SaveToStreamCSV | Saves data in CSV format to a given stream |
| SaveToStreamHTML(Stream) | Saves first worksheet of spreadsheet as HTML document to a given stream. |
| SaveToStreamHTML(Stream, Int32) | Saves a worksheet of spreadsheet as HTML document to a given stream. |
| SaveToStreamTXT | Saves data in TXT format to a given stream |
| SaveToStreamXLS | Saves data in XLS format to a given stream |
| SaveToStreamXLSX | Saves data in XLSX format to a given stream |
| SaveToStreamXML | Saves data in XML format to a given stream |
| SaveViewState | Saves any state that was modified after the TrackViewState method was invoked. (Inherited from WebControl.) |
| SetDesignModeState | Sets design-time data for a control. (Inherited from Control.) |
| SetRenderMethodDelegate | Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control.) |
| SetTraceData(Object, Object) | (Inherited from Control.) |
| SetTraceData(Object, Object, Object) | (Inherited from Control.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| TrackViewState | Causes the control to track changes to its view state so they can be stored in the object's ViewState property. (Inherited from WebControl.) |
| Worksheet | Return Worksheet the specified index. |
Events
| Name | Description | |
|---|---|---|
 | DataBinding | Occurs when the server control binds to a data source. (Inherited from Control.) |
| Disposed | Occurs 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 Control.) |
| Init | Occurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from Control.) |
| Load | Occurs when the server control is loaded into the Page object. (Inherited from Control.) |
| PreRender | Occurs after the Control object is loaded but prior to rendering. (Inherited from Control.) |
| Unload | Occurs when the server control is unloaded from memory. (Inherited from Control.) |
See Also