wxAutoExcel  2.0.0
wxAutoExcel::wxExcelConnectorFormat Class Reference

Represents Microsoft Excel ConnectorFormat object. More...

Inheritance diagram for wxAutoExcel::wxExcelConnectorFormat:
wxAutoExcel::wxExcelObject

Public Member Functions

void BeginConnect (wxExcelShape connectedShape, long connectionSite)
 Attaches the beginning of the specified connector to a specified shape. More...
 
void BeginDisconnect ()
 Detaches the beginning of the specified connector from the shape it’s attached to. More...
 
void EndConnect (wxExcelShape connectedShape, long connectionSite)
 Attaches the end of the specified connector to a specified shape. More...
 
void EndDisconnect ()
 Detaches the end of the specified connector from the shape it’s attached to. More...
 
MsoTriState GetBeginConnected ()
 True if the beginning of the specified connector is connected to a shape. More...
 
wxExcelShape GetBeginConnectedShape ()
 Returns a Shape Represents the shape that the beginning of the specified connector is attached to. More...
 
long GetBeginConnectionSite ()
 Returns an integer that specifies the connection site that the beginning of a connector is connected to. More...
 
MsoTriState GetEndConnected ()
 msoTrue if the end of the specified connector is connected to a shape. More...
 
wxExcelShape GetEndConnectedShape ()
 Returns a Shape Represents the shape that the end of the specified connector is attached to. More...
 
long GetEndConnectionSite ()
 Returns an integer that specifies the connection site that the end of a connector is connected to. More...
 
MsoConnectorType GetType ()
 Returns a MsoConnectorType value that represents the connector format type. More...
 
virtual wxString GetAutoExcelObjectName_ () const
 Returns "ConnectorFormat". More...
 
- Public Member Functions inherited from wxAutoExcel::wxExcelObject
bool IsOk_ () const
 Returns true if the object has a valid dispatch. More...
 
wxString GetAutomationObjectName_ (bool stripUnderscores=false) const
 Returns object name as provided by IDispatch->GetTypeInfo()->GetDocumentation(MEMBERID_NIL, &name, NULL, NULL, NULL). More...
 
wxSharedPtr< wxAutomationObject > GetAutomationObject_ ()
 Returns the underlying wxAutomationObject. More...
 
 operator bool () const
 Returns true if the object has a valid dispatch and its last automation call (if any), i.e. More...
 
WXLCID GetAutomationLCID_ () const
 Returns the locale identifier used in automation calls. More...
 
bool SetAutomationLCID_ (WXLCID lcid)
 Sets the locale identifier to be used in automation calls. More...
 
bool GetPropertyAndMethodNames_ (wxArrayString &propertyNames, wxArrayString &methodNames, bool includeHidden=false)
 Returns lists of property and method names the automation interface exposes. More...
 
bool GetUnimplementedObject_ (const wxString &name, wxAutomationObject &object)
 Helper function for receiving an automation object not implemented in wxAutoExcel, see FAQ on how to use. More...
 

Additional Inherited Members

- Public Types inherited from wxAutoExcel::wxExcelObject
enum  ErrorFlags {
  Err_DoNothing = 0 , Err_LogOnInvalidDispatch = 1 , Err_AssertOnInvalidDispatch = 1 << 1 , Err_ThrowOnInvalidDispatch = 1 << 2 ,
  Err_LogOnInvalidArgument = 1 << 3 , Err_AssertOnInvalidArgument = 1 << 4 , Err_ThrowOnInvalidArgument = 1 << 5 , Err_LogOnFailedInvoke = 1 << 6 ,
  Err_AssertOnFailedInvoke = 1 << 7 , Err_ThrowOnFailedInvoke = 1 << 8 , Err_LogOnInvalidReturnType = 1 << 9 , Err_AssertOnInvalidReturnType = 1 << 10 ,
  Err_ThrowOnInvalidReturnType = 1 << 11 , Err_LogOnOtherError = 1 << 12 , Err_AssertOnOtherError = 1 << 13 , Err_ThrowOnOtherError = 1 << 14
}
 Flags affecting the behaviour of wxExcelObject and its descendants when an error occurs during accessing an Excel object property or calling its method. More...
 
- Static Public Member Functions inherited from wxAutoExcel::wxExcelObject
static unsigned GetErrorMode_ ()
 Sets the error mode to the combination of wxExcelObject::ErrorFlags. More...
 
static void SetErrorMode_ (unsigned mode)
 Sets the error mode as the combination of wxExcelObject::ErrorFlags. More...
 
static bool GetUnimplementedCollectionItem_ (wxAutomationObject &collection, const long index, wxAutomationObject &item, bool asProperty)
 Helper function for obtaining an item from MS Excel collection not implemented in wxAutoExcel, see FAQ on how to use. More...
 

Detailed Description

Represents Microsoft Excel ConnectorFormat object.

Member Function Documentation

◆ BeginConnect()

void wxAutoExcel::wxExcelConnectorFormat::BeginConnect ( wxExcelShape  connectedShape,
long  connectionSite 
)

Attaches the beginning of the specified connector to a specified shape.

If there’s already a connection between the beginning of the connector and another shape, that connection is broken. If the beginning of the connector isn’t already positioned at the specified connecting site, this method moves the beginning of the connector to the connecting site and adjusts the size and position of the connector. Use the EndConnect method to attach the end of the connector to a shape.

MSDN documentation for ConnectorFormat.BeginConnect.

◆ BeginDisconnect()

void wxAutoExcel::wxExcelConnectorFormat::BeginDisconnect ( )

Detaches the beginning of the specified connector from the shape it’s attached to.

This method doesn’t alter the size or position of the connector: the beginning of the connector remains positioned at a connection site but is no longer connected. Use the EndDisconnect method to detach the end of the connector from a shape.

MSDN documentation for ConnectorFormat.BeginDisconnect.

◆ EndConnect()

void wxAutoExcel::wxExcelConnectorFormat::EndConnect ( wxExcelShape  connectedShape,
long  connectionSite 
)

Attaches the end of the specified connector to a specified shape.

If there’s already a connection between the end of the connector and another shape, that connection is broken. If the end of the connector isn’t already positioned at the specified connecting site, this method moves the end of the connector to the connecting site and adjusts the size and position of the connector. Use the BeginConnect method to attach the beginning of the connector to a shape.

MSDN documentation for ConnectorFormat.EndConnect.

◆ EndDisconnect()

void wxAutoExcel::wxExcelConnectorFormat::EndDisconnect ( )

Detaches the end of the specified connector from the shape it’s attached to.

This method doesn’t alter the size or position of the connector: the end of the connector remains positioned at a connection site but is no longer connected. Use the BeginDisconnect method to detach the beginning of the connector from a shape.

MSDN documentation for ConnectorFormat.EndDisconnect.

◆ GetBeginConnected()

MsoTriState wxAutoExcel::wxExcelConnectorFormat::GetBeginConnected ( )

True if the beginning of the specified connector is connected to a shape.

Read-only MsoTriState.

MSDN documentation for ConnectorFormat.BeginConnected.

◆ GetBeginConnectedShape()

wxExcelShape wxAutoExcel::wxExcelConnectorFormat::GetBeginConnectedShape ( )

Returns a Shape Represents the shape that the beginning of the specified connector is attached to.

MSDN documentation for ConnectorFormat.BeginConnectedShape.

◆ GetBeginConnectionSite()

long wxAutoExcel::wxExcelConnectorFormat::GetBeginConnectionSite ( )

Returns an integer that specifies the connection site that the beginning of a connector is connected to.

MSDN documentation for ConnectorFormat.BeginConnectionSite.

◆ GetEndConnected()

MsoTriState wxAutoExcel::wxExcelConnectorFormat::GetEndConnected ( )

msoTrue if the end of the specified connector is connected to a shape.

Read-only MsoTriState.

MSDN documentation for ConnectorFormat.EndConnected.

◆ GetEndConnectedShape()

wxExcelShape wxAutoExcel::wxExcelConnectorFormat::GetEndConnectedShape ( )

Returns a Shape Represents the shape that the end of the specified connector is attached to.

MSDN documentation for ConnectorFormat.EndConnectedShape.

◆ GetEndConnectionSite()

long wxAutoExcel::wxExcelConnectorFormat::GetEndConnectionSite ( )

Returns an integer that specifies the connection site that the end of a connector is connected to.

MSDN documentation for ConnectorFormat.EndConnectionSite.

◆ GetType()

MsoConnectorType wxAutoExcel::wxExcelConnectorFormat::GetType ( )

Returns a MsoConnectorType value that represents the connector format type.

MSDN documentation for ConnectorFormat.Type.

◆ GetAutoExcelObjectName_()

virtual wxString wxAutoExcel::wxExcelConnectorFormat::GetAutoExcelObjectName_ ( ) const
inlinevirtual

Returns "ConnectorFormat".

Reimplemented from wxAutoExcel::wxExcelObject.