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
Public property AltHTML Infrastructure.
Public property Application Gets the creator of the ControlSite.
Public property AutoLoad Gets or sets a value that indicates whether the ControlSite is automatically loaded when the workbook that contains it is opened.
Public property AutoUpdate Gets or sets a value that indicates whether the ControlSite is updated automatically when the source changes.
Public property Border Gets the border of the ControlSite.
Public property BottomRightCell Gets a Range that represents the cell that lies under the lower-right corner of the ControlSite.
Public property Creator Gets a value that indicates the application in which the ControlSite was created.
Public property Enabled Gets or sets a value that indicates whether the ControlSite is enabled.
Public property Height Gets or sets the height, in points, of the ControlSite.
Public property Index Gets the index number of the ControlSite within the collection of similar objects.
Public property Interior Gets the interior of the ControlSite.
Public property 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).
Public property LinkedCell Gets or sets a value that identifies the range linked to the value of the ControlSite.
Public property ListFillRange Gets or sets a value that identifies the range used to fill the specified list box.
Public property Locked Gets or sets a value that indicates whether the ControlSite is locked.
Public property Name Gets or sets the name of the ControlSite.
Public property Object Gets the OLE Automation object associated with the ControlSite.
Public property OLEType Gets the ControlSite type.
Public property OnAction Infrastructure.
Public property Parent Gets the parent object for the ControlSite.
Public property Placement Gets or sets a value that indicates how the ControlSite is attached to the cells below it.
Public property PrintObject Gets or sets a value that indicates whether the ControlSite is printed when the document is printed.
Public property progID Gets the programmatic identifier for the ControlSite.
Public property Shadow Gets or sets a value that indicates whether the font is a shadow font or if the ControlSite has a shadow.
Public property ShapeRange Gets a ShapeRange that represents the specified ControlSite.
Public property SourceName Gets or sets the link source name of the ControlSite.
Public property 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).
Public property TopLeftCell Gets a Range that represents the cell that lies under the upper-left corner of the ControlSite.
Public property Visible Gets or sets a value that indicates whether the ControlSite is visible.
Public property Width Gets or sets the width, in points, of the ControlSite.
Public property ZOrder Gets the z-order position of the ControlSite.

Top

Methods

  Name Description
Public method _VtblGap1_1 Infrastructure.
Public method _VtblGap2_1 Infrastructure.
Public method _VtblGap3_3 Infrastructure.
Public method _VtblGap4_2 Infrastructure.
Public method _VtblGap5_2 Infrastructure.
Public method _VtblGap6_5 Infrastructure.
Public method _VtblGap7_6 Infrastructure.
Public method Activate Activates the ControlSite.
Public method BringToFront Brings the ControlSite to the front of the z-order.
Public method Copy Copies the ControlSite to the Clipboard.
Public method CopyPicture Copies the ControlSite to the Clipboard as a picture.
Public method Cut Cuts the ControlSite to the Clipboard.
Public method Delete Deletes the ControlSite.
Public method Dispose Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)
Public method Duplicate Duplicates the ControlSite and returns a reference to the new copy.
Public method Select Selects the ControlSite.
Public method SendToBack Sends the ControlSite to the back of the z-order.
Public method Update Updates the link.
Public method 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.

See Also

Reference

Microsoft.Office.Tools.Excel Namespace