GrapeCity.Documents.Excel.Drawing.IConnectorFormat

IConnectorFormat Interface

Represents properties and methods that apply to connectors.

Use this interface to inspect and modify connector-specific settings, such as the connector type and the shapes connected to the beginning or end of the connector. You can obtain an IConnectorFormat instance from a connector shape through ConnectorFormat.

Namespace: GrapeCity.Documents.Excel.Drawing

Assembly: DS.Documents.Excel.dll

Syntax

public interface IConnectorFormat

Public Interface IConnectorFormat

Examples

IShape connector = worksheet.Shapes.AddConnector(ConnectorType.Straight, 20, 20, 120, 80);
IConnectorFormat connectorFormat = connector.ConnectorFormat;
connectorFormat.Type = ConnectorType.Elbow;
ConnectorType type = connectorFormat.Type;

Properties

Name	Description
BeginConnected	Gets whether the connector is connected to a shape (true if the beginning of the specified connector is connected to a shape). Use this property to determine whether the beginning of the connector is currently attached to a shape. To connect the beginning of a connector, use BeginConnect(IShape, int).
BeginConnectedShape	Returns the IShape object that represents the shape that the beginning of the specified connector is attached to. Use this property to get the shape connected to the beginning of a connector after the connection is established by BeginConnect(IShape, int).
BeginConnectionSite	Returns an integer that specifies the connection site that the beginning of a connector is connected to. Use this property to get the connection site index at the beginning of a connector after the connection is established by BeginConnect(IShape, int).
EndConnected	Returns whether the end of the connector is connected to a shape. Returns `true` if the end of the specified connector is connected to a shape. Use this property after EndConnect(IShape, int) to determine whether the connector's end point is currently attached.
EndConnectedShape	Returns the IShape object that represents the shape that the end of the specified connector is attached to. Use this property to retrieve the shape currently connected to the end of a connector after calling EndConnect(IShape, int).
EndConnectionSite	Returns an integer that specifies the connection site that the end of a connector is connected to. Use this property after EndConnect(IShape, int) to retrieve the connection site index on the shape attached to the end of the connector.
Type	Gets or sets the connector format type.

Methods

Name	Description
BeginConnect(IShape, int)	Attaches the beginning of the specified connector to a specified shape. Use this method to connect the starting point of a connector to a connection site on a shape. The specified shape must be in the same IShapes collection as the connector.
BeginDisconnect()	Detaches the beginning of the specified connector from the shape it’s attached to. Use this method to remove the connection between the beginning point of a connector and the connected shape.
EndConnect(IShape, int)	Attaches the end of the specified connector to a specified shape. Use this method to connect the ending point of a connector to a connection site on a shape. The specified shape must be in the same IShapes collection as the connector.
EndDisconnect()	Detaches the end of the specified connector from the shape it is attached to. Use this method to remove the connection between a connector's end point and a shape while keeping the connector object available for further repositioning or reconnection.