ControlSite Interface
Represents a linked or embedded control on a worksheet.
Namespace: Microsoft.Office.Tools.Excel
Assemblies: Microsoft.Office.Tools.Excel (in Microsoft.Office.Tools.Excel.dll)
Microsoft.Office.Tools.Excel.v4.0.Utilities (in Microsoft.Office.Tools.Excel.v4.0.Utilities.dll)
Syntax
'Declaration
<GuidAttribute("D7A3AD16-D044-4CDF-989D-AF46A924F1D8")> _
Public Interface ControlSite _
Inherits IDisposable
[GuidAttribute("D7A3AD16-D044-4CDF-989D-AF46A924F1D8")]
public interface ControlSite : IDisposable
The ControlSite type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
AltHTML | Infrastructure. |
|
Application | Gets the creator of the ControlSite. |
|
AutoLoad | Gets or sets a value that indicates whether the ControlSite is automatically loaded when the workbook that contains it is opened. |
|
AutoUpdate | Gets or sets a value that indicates whether the ControlSite is updated automatically when the source changes. |
|
Border | Gets the border of the ControlSite. |
|
BottomRightCell | Gets a Range that represents the cell that lies under the lower-right corner of the ControlSite. |
|
Creator | Gets a value that indicates the application in which the ControlSite was created. |
|
Enabled | Gets or sets a value that indicates whether the ControlSite is enabled. |
|
Height | Gets or sets the height, in points, of the ControlSite. |
|
Index | Gets the index number of the ControlSite within the collection of similar objects. |
|
Interior | Gets the interior of the ControlSite. |
|
Left | Gets or sets the distance, in points, from the left edge of the ControlSite to the left edge of column A (on a worksheet) or the left edge of the chart area (on a chart). |
|
LinkedCell | Gets or sets a value that identifies the range linked to the value of the ControlSite. |
|
ListFillRange | Gets or sets a value that identifies the range used to fill the specified list box. |
|
Locked | Gets or sets a value that indicates whether the ControlSite is locked. |
|
Name | Gets or sets the name of the ControlSite. |
|
Object | Gets the OLE Automation object associated with the ControlSite. |
|
OLEType | Gets the ControlSite type. |
|
OnAction | Infrastructure. |
|
Parent | Gets the parent object for the ControlSite. |
|
Placement | Gets or sets a value that indicates how the ControlSite is attached to the cells below it. |
|
PrintObject | Gets or sets a value that indicates whether the ControlSite is printed when the document is printed. |
|
progID | Gets the programmatic identifier for the ControlSite. |
|
Shadow | Gets or sets a value that indicates whether the font is a shadow font or if the ControlSite has a shadow. |
|
ShapeRange | Gets a ShapeRange that represents the specified ControlSite. |
|
SourceName | Gets or sets the link source name of the ControlSite. |
|
Top | Gets or sets the distance, in points, from the top edge of the ControlSite to the top of row 1 (on a worksheet) or the top of the chart area (on a chart). |
|
TopLeftCell | Gets a Range that represents the cell that lies under the upper-left corner of the ControlSite. |
|
Visible | Gets or sets a value that indicates whether the ControlSite is visible. |
|
Width | Gets or sets the width, in points, of the ControlSite. |
|
ZOrder | Gets the z-order position of the ControlSite. |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
_VtblGap1_1 | |
|
_VtblGap2_1 | |
|
_VtblGap3_3 | |
|
_VtblGap4_2 | |
|
_VtblGap5_2 | |
|
_VtblGap6_5 | |
|
_VtblGap7_6 | |
|
Activate | Activates the ControlSite. |
|
BringToFront | Brings the ControlSite to the front of the z-order. |
|
Copy | Copies the ControlSite to the Clipboard. |
|
CopyPicture | Copies the ControlSite to the Clipboard as a picture. |
|
Cut | Cuts the ControlSite to the Clipboard. |
|
Delete | Deletes the ControlSite. |
|
Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.) |
|
Duplicate | Duplicates the ControlSite and returns a reference to the new copy. |
|
Select | Selects the ControlSite. |
|
SendToBack | Sends the ControlSite to the back of the z-order. |
|
Update | Updates the link. |
|
Verb | Sends a verb to the server of the ControlSite. |
Top
Remarks
A ControlSite is returned when you use the AddControl method to add a control to a document. For more information, see Adding Controls to Office Documents at Run Time.
Note
This interface is implemented by the Visual Studio Tools for Office runtime. It is not intended to be implemented in your code. For more information, see Visual Studio Tools for Office Runtime Overview.