GridWorksheetDesign

GridWorksheetDesign class

Inherited from GridWorksheet. Used in design-time only.

public class GridWorksheetDesign : GridWorksheet

Constructors

Name Description
GridWorksheetDesign() Default constructor.
GridWorksheetDesign(GridWorkbook)

Properties

Name Description
ActiveCell { get; set; } (Inherited from GridWorksheet.)
BackgroundImage { get; set; } Gets and sets worksheet background image.(Inherited from GridWorksheet.)
BindColumns { get; } Bind columns collection.(Inherited from GridWorksheet.)
BindingSource { get; } The actually binding datasource object at run-time. It is a DataView object when the DataSource property is a DataSet, DataTable or DataView object.(Inherited from GridWorksheet.)
BindStartColumn { get; set; } In data-binding mode, BindStartRow and BindStartColumn indicate the position of the grid to bind bo the datasource.(Inherited from GridWorksheet.)
BindStartRow { get; set; } In data-binding mode, BindStartRow and BindStartColumn indicate the position of the grid to bind bo the datasource.(Inherited from GridWorksheet.)
Cells { get; } (Inherited from GridWorksheet.)
CodeName { get; } Represents worksheet code name.(Inherited from GridWorksheet.)
Comments { get; } (Inherited from GridWorksheet.)
CurrentBindRows { get; set; } Gets the binding rows number in data-binding mode.(Inherited from GridWorksheet.)
DataMember { get; set; } Gets or sets the DataMember from the multi-member DataSource. Generally it represents a DataTable object of a DataSet.(Inherited from GridWorksheet.)
DataSource { get; set; } Gets or sets the DataSource. Generally it’s a DataSet object.(Inherited from GridWorksheet.)
DisplayRightToLeft { get; set; } (Inherited from GridWorksheet.)
DisplayZeros { get; set; } True if zero values are displayed.(Inherited from GridWorksheet.)
EnableCreateBindColumnHeader { get; set; } In data-binding mode, indicates whether to create bind column header captions in the sheet.(Inherited from GridWorksheet.)
FirstVisibleColumn { get; set; } (Inherited from GridWorksheet.)
FirstVisibleRow { get; set; } (Inherited from GridWorksheet.)
GridActiveCell { get; set; } (Inherited from GridWorksheet.)
Hyperlinks { get; } Gets the HyperlinkCollection collection.(Inherited from GridWorksheet.)
Index { get; } (Inherited from GridWorksheet.)
IsGridlinesVisible { get; set; } Gets or sets a value indicating whether the grid lines are visible.Default is true.(Inherited from GridWorksheet.)
IsSummaryRowBelow { get; set; } Indicates if the summary row will be positioned below the detail rows in the outline.(Inherited from GridWorksheet.)
Name { get; set; } Gets or sets the name of the worksheet.(Inherited from GridWorksheet.)
OutlineShown { get; set; } Indicates whether show outline.(Inherited from GridWorksheet.)
Pictures { get; } Gets a Pictures collection.(Inherited from GridWorksheet.)
PivotTables { get; } Gets the pivotTables in the worksheet.(Inherited from GridWorksheet.)
Selected { get; set; } Indicates whether this worksheet is selected when the workbook is opened.(Inherited from GridWorksheet.)
Shapes { get; } Gets a Pictures collection.(Inherited from GridWorksheet.)
StandardHeight { get; set; } Gets or sets the default row height in this worksheet,in unit of points.(Inherited from GridWorksheet.)
StandardHeightPixels { get; set; } Gets or sets the default row height in this worksheet,in unit of pixels.(Inherited from GridWorksheet.)
TabColor { get; set; } Represents worksheet tab color.(Inherited from GridWorksheet.)
Validations { get; } Gets the data validation setting collection in the worksheet.(Inherited from GridWorksheet.)
override Visible { get; set; } Indicates whether this sheet’s name is shown in the sheet tabs of the control.(Inherited from GridWorksheet.)
Workbook { get; } (Inherited from GridWorksheet.)
Zoom { get; set; } (Inherited from GridWorksheet.)

Methods

Name Description
AddAutoFilter(int, int, int) Sets the range to which the specified AutoFilter applies.(Inherited from GridWorksheet.)
AddCustomFilter(int, string) Add custom filter for the specified row.(Inherited from GridWorksheet.)
AutoFitColumn(int) Autofits the column width.(Inherited from GridWorksheet.)
AutoFitColumn(int, int, int) Autofits the column width.(Inherited from GridWorksheet.)
AutoFitRow(int) Autofits the row height.(Inherited from GridWorksheet.)
AutoFitRow(int, int, int) Autofits the row height.(Inherited from GridWorksheet.)
AutoFitRow(int, int, int, int) Autofits row height in a rectangle range.(Inherited from GridWorksheet.)
AutoFitRows() Autofits all rows in this worksheet.(Inherited from GridWorksheet.)
AutoFitRows(bool) Autofits all rows in this worksheet.(Inherited from GridWorksheet.)
AutoFitRows(int, int) Autofits row height in a range.(Inherited from GridWorksheet.)
CalculateFormula(string) Calculates a formula.(Inherited from GridWorksheet.)
CancelNewBindRow() Cancels and deletes the new added bind row.(Inherited from GridWorksheet.)
ClearComments() Clears all comments in designer spreadsheet.(Inherited from GridWorksheet.)
CommitNewBindRow() Commits the new added bind row and add it to the datasource.(Inherited from GridWorksheet.)
Copy(GridWorksheet) Copies contents and formats from another worksheet.(Inherited from GridWorksheet.)
CreateAutoGenratedColumns() After setting a datasource for the worksheet, call this method to generate the bind columns automatically.(Inherited from GridWorksheet.)
CreateNewBindRow() Creates a new bind row and bind to the datasource.(Inherited from GridWorksheet.)
CreateSubtotal(int, int, int, SubtotalFunction, int[]) Creates subtotal in the sheet.(Inherited from GridWorksheet.)
CreateSubtotal(int, int, int, SubtotalFunction, int[], string, GridTableItemStyle, GridTableItemStyle, NumberType, string) Creates subtotal in the sheet.(Inherited from GridWorksheet.)
override DataBind() Bind the sheet to the DataSource.(Inherited from GridWorksheet.)
DataSourceControlUpdate(AccessDataSource) Bind the sheet to the DataSource.(Inherited from GridWorksheet.)
DeleteBindRow(int) Deletes a bind row.(Inherited from GridWorksheet.)
FilterString(int, string) Sets the filter for the column.notice we shall call AddAutoFilter before calling of filterString The filter criteria string. notice we use comma->"," as split char,so the cell value you want to filter shall not contains with comma filterString(10,“123,456”) means column 10 shall contain 123 or 456, filterString(10,“123”) means column10 shall contain 123 value split with comma,eg. 123,456,789 or abc(Inherited from GridWorksheet.)
FreezePanes(string, int, int) Freezes panes at the specified cell in the worksheet.(Inherited from GridWorksheet.)
FreezePanes(int, int, int, int) Freezes panes at the specified cell in the worksheet.(Inherited from GridWorksheet.)
GetColumnCaption(int) Gets the column caption. If the caption is not set, returns empty string.(Inherited from GridWorksheet.)
GetColumnHeaderToolTip(int) Gets the columnheader’s tooltip text.(Inherited from GridWorksheet.)
GetColumnReadonly(int) Gets if a column is readonly. this is extended method of GridWeb specifically,it will not keep and take affect in actual excel file(Inherited from GridWorksheet.)
GetFreezedPanes(out int, out int, out int, out int) Gets the freeze panes.(Inherited from GridWorksheet.)
GetIsReadonly(int, int) Gets whether the cell is readonly.this is an extended attribute of GridWeb ,it will not keep in actual excel file(Inherited from GridWorksheet.)
GetRowCaption(int) Gets the row caption. If the caption is not set, returns empty string.(Inherited from GridWorksheet.)
GetRowHeaderToolTip(int) Gets the rowheader’s tooltip text.(Inherited from GridWorksheet.)
GetRowReadonly(int) Gets if a row is readonly. this is extended method of GridWeb specifically,it will not keep and take affect in actual excel file(Inherited from GridWorksheet.)
GroupRows(int, int, bool) Groups rows.(Inherited from GridWorksheet.)
IsProtected() Indicates if the worksheet is protected.(Inherited from GridWorksheet.)
MoveTo(int) Moves the sheet to another location in the spreadsheet.(Inherited from GridWorksheet.)
RefreshFilter() Refresh auto filters to hide or unhide the rows.(Inherited from GridWorksheet.)
RemoveAutoFilter() Remove the auto filter of the worksheet.(Inherited from GridWorksheet.)
RemoveSubtotal() Removes subtotal created by the CreateSubtotal method in the sheet.(Inherited from GridWorksheet.)
ResetFilter(int) The integer offset of the field on which you want to apply ,based on the first filter column (from the left of the list; the leftmost field is field 0).(Inherited from GridWorksheet.)
SetAllCellsEditable() Makes all cells editable.this is extended attribute(Inherited from GridWorksheet.)
SetAllCellsReadonly() Makes all cells readonly.this is extended attribute notice this attribute can not keep in actual cell,if you want to keep protect please use setProtect(Inherited from GridWorksheet.)
SetColumnCaption(int, string) Sets the caption for the column.please note this is an extension attribute and can not keep in excel file(Inherited from GridWorksheet.)
SetColumnHeaderToolTip(int, string) Sets the columnheader’s tooltip text.(Inherited from GridWorksheet.)
SetColumnReadonly(int, bool) Sets a column to readonly so user can’t delete it from client side. this is extended method of GridWeb specifically,it will not keep and take affect in actual excel file(Inherited from GridWorksheet.)
SetEditableRange(int, int, int, int) Makes a range of cells editable. http://docs.aspose.com:8082/docs/display/cellsnet/Protecting+Cells Make all cells read only by calling the SetAllCellsReadonly method. then call this method to Specify the range of cells that to be editable(Inherited from GridWorksheet.)
SetIsReadonly(int, int, bool) Sets whether the cell is readonly.this is an extended attribute of GridWeb ,it will not keep in actual excel file(Inherited from GridWorksheet.)
SetProtect() Protects worksheet.(Inherited from GridWorksheet.)
SetReadonlyRange(int, int, int, int) Makes a range of cells readonly. http://docs.aspose.com:8082/docs/display/cellsnet/Protecting+Cells First make all cells editable by calling the SetAllCellsEditable method. then call this method to Specify the range of cells that to be readonly(Inherited from GridWorksheet.)
SetRowCaption(int, string) Sets the caption for the row.(Inherited from GridWorksheet.)
SetRowHeaderToolTip(int, string) Sets the rowheader’s tooltip text.(Inherited from GridWorksheet.)
SetRowReadonly(int, bool) Sets a row to readonly so user can’t delete it from client side. this is extended method of GridWeb specifically,it will not keep and take affect in actual excel file(Inherited from GridWorksheet.)
UnFreezePanes() Unfreezes panes in the worksheet.(Inherited from GridWorksheet.)
UnGroupRows(int, int) Ungroups rows.(Inherited from GridWorksheet.)
UnProtect() unProtects worksheet.(Inherited from GridWorksheet.)

See Also