wxAutoExcel  2.0.0
wxAutoExcel::wxExcelDocumentProperty Class Reference

Represents a Microsoft Excel DocumentProperty object. More...

Inheritance diagram for wxAutoExcel::wxExcelDocumentProperty:
wxAutoExcel::wxExcelObject

Public Member Functions

void Delete ()
 Removes a custom document property. More...
 
wxString GetLinkSource ()
 Gets the source of a linked custom document property. More...
 
void SetLinkSource (const wxString &linkSource)
 Sets the source of a linked custom document property. More...
 
bool GetLinkToContent ()
 Is true if the value of the custom document property is linked to the content of the container document. More...
 
void SetLinkToContent (bool linkToContent)
 Is true if the value of the custom document property is linked to the content of the container document. More...
 
wxString GetName ()
 The name of a document property. More...
 
void SetName (const wxString &name)
 The name of a document property. More...
 
MsoDocProperties GetType ()
 The document property type. More...
 
void SetType (MsoDocProperties propertyType)
 The document property type. More...
 
wxVariant GetValue ()
 The value of a document property. More...
 
void SetValue (const wxVariant &value)
 The value of a document property. More...
 
virtual wxString GetAutoExcelObjectName_ () const
 Returns "DocumentProperty". 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 a Microsoft Excel DocumentProperty object.

Member Function Documentation

◆ Delete()

void wxAutoExcel::wxExcelDocumentProperty::Delete ( )

Removes a custom document property.

MSDN documentation for DocumentProperty.Delete.

◆ GetLinkSource()

wxString wxAutoExcel::wxExcelDocumentProperty::GetLinkSource ( )

Gets the source of a linked custom document property.

MSDN documentation for DocumentProperty.LinkSource.

◆ SetLinkSource()

void wxAutoExcel::wxExcelDocumentProperty::SetLinkSource ( const wxString &  linkSource)

Sets the source of a linked custom document property.

MSDN documentation for DocumentProperty.LinkSource.

◆ GetLinkToContent()

bool wxAutoExcel::wxExcelDocumentProperty::GetLinkToContent ( )

Is true if the value of the custom document property is linked to the content of the container document.

False if the value is static.

MSDN documentation for DocumentProperty.LinkToContent.

◆ SetLinkToContent()

void wxAutoExcel::wxExcelDocumentProperty::SetLinkToContent ( bool  linkToContent)

Is true if the value of the custom document property is linked to the content of the container document.

False if the value is static.

MSDN documentation for DocumentProperty.LinkToContent.

◆ GetName()

wxString wxAutoExcel::wxExcelDocumentProperty::GetName ( )

The name of a document property.

MSDN documentation for DocumentProperty.Name.

◆ SetName()

void wxAutoExcel::wxExcelDocumentProperty::SetName ( const wxString &  name)

The name of a document property.

MSDN documentation for DocumentProperty.Name.

◆ GetType()

MsoDocProperties wxAutoExcel::wxExcelDocumentProperty::GetType ( )

The document property type.

Read-only for built-in document properties; read/write for custom document properties.

MSDN documentation for DocumentProperty.Type.

◆ SetType()

void wxAutoExcel::wxExcelDocumentProperty::SetType ( MsoDocProperties  propertyType)

The document property type.

Read-only for built-in document properties; read/write for custom document properties.

MSDN documentation for DocumentProperty.Type.

◆ GetValue()

wxVariant wxAutoExcel::wxExcelDocumentProperty::GetValue ( )

The value of a document property.

MSDN documentation for DocumentProperty.Value.

◆ SetValue()

void wxAutoExcel::wxExcelDocumentProperty::SetValue ( const wxVariant &  value)

The value of a document property.

MSDN documentation for DocumentProperty.Value.

◆ GetAutoExcelObjectName_()

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

Returns "DocumentProperty".

Reimplemented from wxAutoExcel::wxExcelObject.