XlsWorksheetBase module

class XlsWorksheetBase.XlsWorksheetBase

Bases: XlsObject, INamedObject, ITabSheet, ICloneParent

Activate()

<summary>

Makes the current sheet the active sheet. Equivalent to clicking the: sheet’s tab in MS Excel.

</summary>

AddTextEffectShape(effect: PresetTextEffect, text: str, upperLeftRow: int, top: int, upperLeftColumn: int, left: int, height: int, width: int) → IShape

property ArcShapes: IArcShapes

property ButtonShapes: IButtonShapes

property Charts: IChartShapes

property CheckBoxes: ICheckBoxes

Clone(parent: SpireObject) → SpireObject

property CodeName: str

<summary>: Name used by macros to access workbook items.

</summary>

property ComboBoxes: IComboBoxes

property Comments: IComments

static DEF_MIN_COLUMN_INDEX() → int

property DefaultGridlineColor: bool

<summary>: Indicates whether gridline color has default value.

</summary>

property FirstColumn: int

<summary>: Gets or sets index of the first column of the worksheet.

</summary>

property FirstDataColumn: int

<summary>: Gets index of the first data column of the worksheet.

</summary>

property FirstDataRow: int

<summary>: Gets index of the first data row of the worksheet.

</summary>

property FirstRow: int

<summary>: Gets / sets index of the first row of the worksheet.

</summary>

property GridLineColor: ExcelColors

<summary>: Grid line color.

<example>The following code illustrates how to set the grid line color: <code> //Create worksheet Workbook workbook = new Workbook(); Worksheet worksheet = workbook.Worksheets[0]; //Set grid lines color worksheet.GridLineColor = ExcelColors.Red; //Save to file workbook.SaveToFile(“GridLineColor.xlsx”); </code> </example>

</summary>

property GroupBoxes: IGroupBoxes

property HasPictures: bool

property HasVmlShapes: bool

<summary>: Indicates whether worksheet has vml shapes. Read-only.

</summary>

property HeaderFooterShapes: XlsHeaderFooterShapeCollection

<summary>: Header / footer shapes collection.

</summary>

property Index: int

<summary>: Returns the index number of the object within the collection of objects.

</summary>

property IsPasswordProtected: bool

property IsRightToLeft: bool

<summary>: Indicates whether worksheet is displayed right to left.

</summary>

property IsRowColHeadersVisible: bool

<summary>: Gets or sets whether the worksheet will display row and column headers. Default is true.

</summary>

property IsSelected: bool

<summary>: Indicates whether tab of this sheet is selected. Read-only.

</summary>

property IsTransitionEvaluation: bool

property LabelShapes: ILabelShapes

property LastColumn: int

<summary>: Gets or sets index of the last column of the worksheet.

</summary>

property LastDataColumn: int

<summary>: Gets index of the last data column of the worksheet.

</summary>

property LastDataRow: int

<summary>: Gets index of the last data row of the worksheet.

</summary>

property LastRow: int

<summary>: Gets or sets one-based index of the last row of the worksheet.

</summary>

property LeftVisibleColumn: int

<summary>: Gets/sets left visible column of the worksheet.

<example>The following code illustrates how to set the left visible column: <code> //Create worksheet Workbook workbook = new Workbook(); Worksheet worksheet = workbook.Worksheets[0]; //Set left visible column worksheet.LeftVisibleColumn = 3; //Get left visible column Console.Write(worksheet.LeftVisibleColumn); //Save to file workbook.SaveToFile(“LeftVisibleColumn.xlsx”); </code> </example>

</summary>

property Lines: ILines

property ListBoxes: IListBoxes

property Name: str

<summary>: Returns or sets the name of the object. Read / write String.

</summary>

property OvalShapes: IOvalShapes

property ParentWorkbook: XlsWorkbook

property Pictures: IPictures

Protect

<summary>: Protects worksheet with password.

</summary> <param name=”password”>Protection password.</param>

<remarks>Password should be less than 15 symbols.</remarks>

property ProtectContents: bool

<summary>: Indicates is current sheet is protected.

</summary>

property ProtectDrawingObjects: bool

<summary>: True if objects are protected. Read only.

</summary>

property ProtectScenarios: bool

<summary>: True if the scenarios of the current sheet are protected. Read only.

</summary>

property Protection: SheetProtectionType

property PrstGeomShapes: PrstGeomShapeCollection

property QueryTables: QueryTableCollection

property RadioButtons: IRadioButtons

property RealIndex: int

property RectangleShapes: IRectangleShapes

property ScrollBarShapes: IScrollBarShapes

Select()

SelectTab()

SetChanged()

property SheetId: int

<summary>: Gets or sets sheetId for this sheet.

</summary>

property SpinnerShapes: ISpinnerShapes

property TabColor: Color

<summary>: Tab color.

</summary>

property TabColorObject: OColor

property TabIndex: int

property TabKnownColor: ExcelColors

<summary>: Tab excel color.

</summary>

property TextBoxes: ITextBoxes

<summary>: Returns inner textboxes collection. Read-only.

</summary>

property TopVisibleRow: int

<summary>: Gets/sets top visible row of the worksheet.

<example>The following code illustrates how to set the top visible row: <code> //Create worksheet Workbook workbook = new Workbook(); Worksheet worksheet = workbook.Worksheets[0]; //Set top visible row worksheet.TopVisibleRow = 5; //Get top visible row Console.Write(worksheet.TopVisibleRow); //Save to file workbook.SaveToFile(“TopVisibleRow.xlsx”); </code> </example>

</summary>

property TypedArcs: ArcShapeCollection

property TypedButtons: ButtonShapeCollection

<summary>: Returns inner buttons collection. Read-only.

</summary>

property TypedCheckBoxes: CheckBoxCollection

property TypedComboBoxes: ComboBoxCollection

property TypedGroupBoxes: GroupBoxCollection

<summary>: Returns inner gourpboxes collection. Read-only.

</summary>

property TypedLabels: LabelShapeCollection

<summary>: Returns inner labels collection. Read-only.

</summary>

property TypedLines: LineCollection

<summary>: Returns inner lines collection. Read-only.

</summary>

property TypedListBoxes: ListBoxCollection

<summary>: Returns inner listboxes collection. Read-only.

</summary>

property TypedOvals: OvalShapeCollection

<summary>: Returns inner ovals collection. Read-only.

</summary>

property TypedPictures: PicturesCollection

<summary>: Returns inner pictures collection. Read-only.

</summary>

property TypedRadioButtons: RadioButtonCollection

property TypedRects: RectangleCollection

<summary>: Returns inner rects collection. Read-only.

</summary>

property TypedScollBars: ScrollBarCollection

<summary>: Returns inner scollbars collection. Read-only.

</summary>

property TypedSpinners: SpinnerShapeCollection

<summary>: Returns inner spinners collection. Read-only.

</summary>

property TypedTextBoxes: TextBoxCollection

<summary>: Returns inner textboxes collection. Read-only.

</summary>

property UnknownVmlShapes: bool

<summary>: Indicates whether worksheet contains some unknown vml shapes.

</summary>

Unprotect

<summary>: Unprotects this wokrsheet.

</summary>

Unselect

property Visibility: WorksheetVisibility

<summary>: Controls end user visibility of worksheet.

</summary>

property VmlShapesCount: int

property Workbook: IWorkbook

property Zoom: int

<summary>: Zoom factor of document.

</summary>

<remarks> Value of zoom should be between 10 and 400.</remarks>