Share via


Worksheet Members (2007 System)

Include Protected Members
Include Inherited Members

Represents a worksheet that exposes events and acts as a container for controls in Visual Studio Tools for Office projects for Microsoft Office Excel.

The Worksheet type exposes the following members.

Constructors

 

Name

Description

Public method

Worksheet

Infrastructure. Overloaded.

Top

Methods

 

Name

Description

Public method

_CheckSpelling

Infrastructure.

Public method

_Evaluate

Infrastructure.

Public method

_PasteSpecial

Infrastructure.

Public method

_PrintOut

Infrastructure.

Public method

_Protect

Infrastructure.

Public method

_SaveAs

Infrastructure.

Public method

Activate

Makes the current sheet the active sheet.

Public method

Arcs

Infrastructure.

Public method

BeginInit

Infrastructure.

Public method

Buttons

Infrastructure.

Public method

CalculateMethod

Calculates the formulas in the worksheet.

Public method

ChartObjects

Gets an object that represents either a single embedded chart (a ChartObject) or a collection of all the embedded charts (a ChartObjects) on the worksheet.

Public method

CheckBoxes

Infrastructure.

Public method

CheckSpelling

Checks the spelling in a worksheet.

Protected method

CheckValidState

(Inherited from RemoteComponent.)

Public method

CircleInvalid

Circles invalid entries on the worksheet.

Public method

ClearArrows

Clears the tracer arrows from the worksheet. Tracer arrows are added by using the auditing feature.

Public method

ClearCircles

Clears circles from invalid entries on the worksheet.

Public method

Copy

Copies the worksheet to another location in the workbook.

Public method

Delete

Deletes the underlying Worksheet object, but does not delete the host item. It is highly recommended that this method not be used.

Public method

Dispose

Overloaded. Releases the unmanaged resources used by the Worksheet and optionally releases the managed resources.

Public method

DrawingObjects

Infrastructure.

Public method

Drawings

Infrastructure.

Public method

DropDowns

Infrastructure.

Public method

EndInit

Infrastructure.

Public method

Equals

Determines whether the specified Object is equal to the current Object. (Inherited from Object.)

Public method

Evaluate

Converts a Microsoft Office Excel name to an object or a value.

Public method

ExportAsFixedFormat

Exports to a file of the specified format.

Protected method

Finalize

(Inherited from RemoteComponent.)

Protected method

FinishInitialization

(Inherited from EntryPointComponentBase.)

Public method

get_Range

Infrastructure. Use the Range property instead of this method.

Protected method

GetAutomationObject

Called by the Visual Studio Tools for Office runtime to get an object that can be used by VBA code in the worksheet.

Public method

GetHashCode

Serves as a hash function for a particular type. (Inherited from Object.)

Protected method

GetHostItem<T>

(Inherited from RemoteComponent.)

Protected method

GetPrimaryControl

Infrastructure.

Protected method

GetService

(Inherited from RemoteComponent.)

Public method

GetType

Gets the type of the current instance. (Inherited from Object.)

Public methodStatic member

GetVstoObject

Returns an Excel worksheet host item that extends the functionality of the specified native Excel worksheet.

Public method

GroupBoxes

Infrastructure.

Public method

GroupObjects

Infrastructure.

Public methodStatic member

HasVstoObject

Returns a value that indicates whether an Excel Microsoft.Office.Tools.Excel.Worksheet host item has been created for the specified native Excel _Worksheet.

Protected method

Initialize

Infrastructure. (Overrides EntryPointComponentBase.Initialize().)

Protected method

InitializeControl

(Inherited from RemoteComponent.)

Protected method

InitializeDataBindings

(Inherited from EntryPointComponentBase.)

Public method

Labels

Infrastructure.

Public method

Lines

Infrastructure.

Public method

ListBoxes

Infrastructure.

Protected method

MemberwiseClone

Creates a shallow copy of the current Object. (Inherited from Object.)

Public method

Move

Moves the worksheet to another location in the workbook.

Public method

OLEObjects

Gets an object that represents either a single OLE object (an OLEObject) or a collection of all OLE objects (an OLEObjects collection) on the worksheet.

Protected method

OnBindingContextChanged

(Inherited from EntryPointBindableComponentBase.)

Protected method

OnShutdown

Infrastructure. (Overrides EntryPointComponentBase.OnShutdown().)

Protected method

OnStartup

Infrastructure. (Overrides EntryPointComponentBase.OnStartup().)

Public method

OptionButtons

Infrastructure.

Public method

Ovals

Infrastructure.

Public method

Paste

Pastes the contents of the Clipboard onto the worksheet.

Public method

PasteSpecial

Pastes the contents of the Clipboard onto the worksheet, using a specified format. Use this method to paste data from other applications or to paste data in a specific format.

Public method

Pictures

Infrastructure.

Public method

PivotTables

Gets an object that represents either a single PivotTable report (a PivotTable object) or a collection of all the PivotTable reports (a PivotTables object) on a worksheet.

Public method

PivotTableWizard

Creates a PivotTable object.

Public method

PrintOut

Prints the worksheet.

Public method

PrintOutEx

Prints the worksheet.

Public method

PrintPreview

Shows a preview of the worksheet as it would look when printed.

Public method

Protect

Protects a worksheet so that it cannot be modified.

Public method

Rectangles

Infrastructure.

Public method

ResetAllPageBreaks

Resets all page breaks on the specified worksheet.

Public method

SaveAs

Saves changes to the worksheet in a different file.

Public method

Scenarios

Gets an object that represents either a single scenario (a Scenario object) or a collection of scenarios (a Scenarios object) on the worksheet.

Public method

ScrollBars

Infrastructure.

Public method

Select

Selects the worksheet.

Public method

SetBackgroundPicture

Sets the background graphic for the worksheet.

Protected method

SetPrimaryCookie

(Inherited from RemoteComponent.)

Public method

ShowAllData

Makes all rows of the currently filtered list visible. If AutoFilter is in use, this method changes the arrows to "All."

Public method

ShowDataForm

Displays the data form associated with the worksheet.

Public method

Spinners

Infrastructure.

Public method

TextBoxes

Infrastructure.

Public method

ToString

Returns a string that represents the current object. (Inherited from Object.)

Public method

Unprotect

Removes protection from the worksheet. This method has no effect if the worksheet is not protected.

Public method

XmlDataQuery

Gets a Range object that represents the cells mapped to a particular XPath. Gets nulla null reference (Nothing in Visual Basic) if the specified XPath has not been mapped to the worksheet, or if the mapped range is empty.

Public method

XmlMapQuery

Gets a Range object that represents the cells mapped to a particular XPath. Gets nulla null reference (Nothing in Visual Basic) if the specified XPath has not been mapped to the worksheet.

Top

Properties

 

Name

Description

Public property

_CodeName

Infrastructure.

Public property

_DisplayRightToLeft

Infrastructure.

Public property

Application

This property gets a Application that represents the Microsoft Office Excel application.

Public property

AutoFilter

Gets a AutoFilter that provides information about filtered lists on the worksheet if filtering is enabled. Gets nulla null reference (Nothing in Visual Basic) if filtering is off.

Public property

AutoFilterMode

Gets or sets a value that indicates whether filtering is currently enabled on the worksheet (that is, whether the filter drop-down arrows are currently displayed).

Public property

BindingContext

(Inherited from EntryPointBindableComponentBase.)

Public property

Cells

Gets a Range object that represents all the cells on the worksheet (not just the cells that are currently in use).

Public property

CircularReference

Gets a Range object that represents the range containing the first circular reference on the sheet, or gets nulla null reference (Nothing in Visual Basic) if there is no circular reference on the sheet.

Public property

CodeName

Infrastructure.

Public property

Columns

Gets a Range object that represents one or more columns on the worksheet.

Public property

Comments

Gets a Comments collection that represents all the comments for the worksheet.

Public property

ConsolidationFunction

Gets the function code used for the current consolidation.

Public property

ConsolidationOptions

Gets a three-element Array of consolidation options.

Public property

ConsolidationSources

Gets an Array of strings that name the source sheets and ranges for the worksheet's current consolidation.

Public property

Container

(Inherited from RemoteComponent.)

Public property

ContainerComponent

(Inherited from EntryPointBindableComponentBase.)

Public property

Controls

Gets the collection of managed controls that are contained on the worksheet.

Public property

Creator

Gets a value that indicates the application in which the worksheet was created.

Public property

CustomProperties

Gets a CustomProperties object representing the identifier information associated with a worksheet.

Public property

DataBindings

(Inherited from EntryPointBindableComponentBase.)

Protected property

DataHost

(Inherited from EntryPointComponentBase.)

Public property

DefaultDataSourceUpdateMode

(Inherited from EntryPointBindableComponentBase.)

Protected property

DesignMode

(Inherited from RemoteComponent.)

Public property

DisplayAutomaticPageBreaks

Infrastructure.

Public property

DisplayPageBreaks

Gets or sets a value that indicates whether page breaks (both automatic and manual) on the worksheet are displayed.

Public property

DisplayRightToLeft

Gets or sets a value that indicates whether the worksheet is displayed from right to left instead of from left to right.

Public property

EnableAutoFilter

Gets or sets a value that indicates whether AutoFilter arrows are enabled when user-interface-only protection is turned on.

Public property

EnableCalculation

Gets or set a value that indicates whether Microsoft Office Excel automatically recalculates the worksheet when necessary.

Public property

EnableFormatConditionsCalculation

Gets or sets a value that determines whether conditional formats will occur automatically.

Public property

EnableOutlining

Gets or sets a value that indicates whether outlining symbols are enabled when user-interface-only protection is turned on.

Public property

EnablePivotTable

Gets or sets a value that indicates whether PivotTable controls and actions are enabled when user-interface-only protection is turned on.

Public property

EnableSelection

Gets or sets a value indicating which cells can be selected on the sheet.

Public property

FilterMode

Gets a value that indicates whether the worksheet is actively filtering data.

Protected property

HostContext

(Inherited from RemoteComponent.)

Public property

HPageBreaks

Gets an HPageBreaks collection that represents the horizontal page breaks on the sheet.

Public property

Hyperlinks

Gets a Hyperlinks collection that represents the hyperlinks for the range or worksheet.

Protected property

Identifier

(Inherited from RemoteComponent.)

Public property

Index

Gets the index number of the worksheet within the collection of worksheets.

Public property

InnerObject

Gets a Worksheet that represents the underlying native object for the Worksheet.

Protected property

InnerType

(Inherited from RemoteComponent.)

Protected property

ItemProvider

(Inherited from RemoteComponent.)

Public property

ListObjects

Gets a collection of ListObject objects in the worksheet.

Public property

MailEnvelope

Gets an e-mail header for the worksheet.

Public property

Name

Gets or sets the name of the worksheet.

Public property

Names

Gets a Names collection that represents all the worksheet-specific names (names defined with the "WorksheetName!" prefix).

Public property

Next

Gets a Worksheet that represents the next sheet.

Public property

OnCalculate

Infrastructure.

Public property

OnData

Infrastructure.

Public property

OnDoubleClick

Infrastructure.

Public property

OnEntry

Infrastructure.

Public property

OnSheetActivate

Infrastructure.

Public property

OnSheetDeactivate

Infrastructure.

Public property

Outline

Gets an Outline that represents the outline for the worksheet.

Public property

PageSetup

Gets a PageSetup that contains all the page setup settings for the worksheet.

Public property

Parent

Gets the parent object for the worksheet.

Public property

Previous

Gets a Worksheet that represents the previous sheet.

Protected property

PrimaryCookie

(Inherited from RemoteComponent.)

Public property

ProtectContents

Gets a value that indicates whether the contents of the worksheet (the individual cells) are protected.

Public property

ProtectDrawingObjects

Gets a value that indicates whether shapes are protected.

Public property

Protection

Gets a Protection object that represents the protection options of the worksheet.

Public property

ProtectionMode

Gets a value that indicates whether user interface-only protection is turned on.

Public property

ProtectScenarios

Gets a value that indicates whether worksheet scenarios are protected.

Public property

QueryTables

Gets the QueryTables collection that represents all the query tables on the worksheet.

Public property

Range

Gets a Range object that represents a cell or a range of cells.

Public property

Rows

Gets a Range object that represents one or more rows on the worksheet.

Public property

Scripts

Gets the Scripts collection, which contains Script objects representing blocks of script or code in the worksheet when it is saved as a Web page.

Public property

ScrollArea

Gets or sets the range where scrolling is allowed, as an A1-style range reference.

Public property

Shapes

Gets a Shapes object that represents all the shapes on the worksheet.

Public property

Site

(Inherited from RemoteComponent.)

Public property

SmartTags

Gets a SmartTags object representing the collection of smart tags for the worksheet.

Public property

Sort

Gets the sorted values in the current worksheet.

Public property

StandardHeight

Gets the standard (default) height of all the rows in the worksheet, in points.

Public property

StandardWidth

Gets or sets the standard (default) width of all the columns in the worksheet.

Public property

Tab

Gets a Tab for the worksheet.

Public property

Tag

(Inherited from RemoteComponent.)

Public property

TransitionExpEval

Gets or sets a value that indicates whether Microsoft Office Excel uses Lotus 1-2-3 expression evaluation rules for the worksheet.

Public property

TransitionFormEntry

Gets or sets a value that indicates whether Microsoft Office Excel uses Lotus 1-2-3 formula entry rules for the worksheet.

Public property

Type

Gets the worksheet type.

Public property

UsedRange

Gets a Range object that represents all the cells that have contained a value at any time.

Public property

Visible

Gets or sets a XlSheetVisibility value that determines whether the object is visible.

Public property

VPageBreaks

Gets a VPageBreaks collection that represents the vertical page breaks on the sheet.

Top

Events

 

Name

Description

Public event

ActivateEvent

Occurs when the worksheet is activated.

Public event

BeforeDoubleClick

Occurs when the worksheet is double-clicked, before the default double-click action.

Public event

BeforeRightClick

Occurs when the worksheet is right-clicked, before the default right-click action.

Public event

BindingContextChanged

(Inherited from EntryPointBindableComponentBase.)

Public event

Calculate

Occurs after the worksheet is recalculated.

Public event

Change

Occurs when something changes in the Worksheet cells.

Public event

Deactivate

Occurs when the worksheet loses focus.

Public event

Disposed

(Inherited from RemoteComponent.)

Public event

FollowHyperlink

Occurs when you click any hyperlink on a worksheet.

Public event

PivotTableUpdate

Occurs after a PivotTable report is updated on a worksheet.

Public event

SelectionChange

Occurs when the selection changes on a worksheet.

Public event

Shutdown

Occurs when the worksheet host item shuts down.

Public event

Startup

Occurs after the worksheet is running and all the initialization code in the assembly has been run.

Top

Explicit Interface Implementations

 

Name

Description

Explicit interface implemetationPrivate method

IEntryPoint.FinishInitialization

(Inherited from EntryPointComponentBase.)

Explicit interface implemetationPrivate method

IEntryPoint.Initialize

(Inherited from EntryPointComponentBase.)

Explicit interface implemetationPrivate method

ISupportInitializeControl.InitializeControl

Infrastructure.

Explicit interface implemetationPrivate method

IEntryPoint.InitializeDataBindings

(Inherited from EntryPointComponentBase.)

Explicit interface implemetationPrivate method

IEntryPoint.OnShutdown

(Inherited from EntryPointComponentBase.)

Top

See Also

Reference

Worksheet Class

Microsoft.Office.Tools.Excel Namespace