Represents a Microsoft Excel (Office) DocumentProperties collection. More...

#include <wxAutoExcelDocumentProperties.h>

Inheritance diagram for wxAutoExcel::wxExcelDocumentProperties:

Public Types
typedef wxExcelCollectionIterator< wxExcelDocumentProperties, wxExcelDocumentProperty >	iterator
	The iterator over the items, see wxExcelCollectionIterator.
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...

Public Member Functions
wxExcelDocumentProperty	Add (const wxString &name, bool linkToContent, MsoDocProperties propertyType, wxVariant *value=NULL, const wxString &linkSource=wxEmptyString)
	Creates a new custom document property.
long	GetCount ()
	Returns the number of items in the collection.
wxExcelDocumentProperty	GetItem (long index)
	Returns a single DocumentProperty object from the collection.
iterator	begin ()
	Returns the iterator referring to the first item, or past the last item, which allows iterating over the items with a range-based for loop, see wxExcelCollectionIterator.
virtual wxString	GetAutoExcelObjectName_ () const
	Returns "DocumentProperties".
Public Member Functions inherited from wxAutoExcel::wxExcelObject
bool	IsOk_ () const
	Returns true if the object has a valid dispatch.
wxString	GetAutomationObjectName_ (bool stripUnderscores=false) const
	Returns object name as provided by IDispatch->GetTypeInfo()->GetDocumentation(MEMBERID_NIL, &name, NULL, NULL, NULL).
wxSharedPtr< wxAutomationObject >	GetAutomationObject_ ()
	Returns the underlying wxAutomationObject.
	operator bool () const
	Returns true if the object has a valid dispatch and its last automation call (if any), i.e.
bool	IsLastResultNull_ () const
	Returns true if MS Excel returned Null (or Empty) for the last property or method, e.g.
WXLCID	GetAutomationLCID_ () const
	Returns the locale identifier used in automation calls.
bool	SetAutomationLCID_ (WXLCID lcid)
	Sets the locale identifier to be used in automation calls.
bool	GetPropertyAndMethodNames_ (wxArrayString &propertyNames, wxArrayString &methodNames, bool includeHidden=false)
	Returns lists of property and method names the automation interface exposes.
bool	GetUnimplementedObject_ (const wxString &name, wxAutomationObject &object)
	Helper function for receiving an automation object not implemented in wxAutoExcel, see FAQ on how to use.

Additional Inherited Members
Static Public Member Functions inherited from wxAutoExcel::wxExcelObject
static unsigned	GetErrorMode_ ()
	Sets the error mode to the combination of wxExcelObject::ErrorFlags.
static void	SetErrorMode_ (unsigned mode)
	Sets the error mode as the combination of wxExcelObject::ErrorFlags.
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.

Detailed Description

Represents a Microsoft Excel (Office) DocumentProperties collection.

Member Typedef Documentation

◆ iterator

typedef wxExcelCollectionIterator<wxExcelDocumentProperties, wxExcelDocumentProperty> wxAutoExcel::wxExcelDocumentProperties::iterator

The iterator over the items, see wxExcelCollectionIterator.

Member Function Documentation

◆ Add()

wxExcelDocumentProperty wxAutoExcel::wxExcelDocumentProperties::Add	(	const wxString &	name,
		bool	linkToContent,
		MsoDocProperties	propertyType,
		wxVariant *	value = NULL,
		const wxString &	linkSource = wxEmptyString )

Creates a new custom document property.

You can add a new document property only to the custom DocumentProperties collection.

MSDN documentation for DocumentProperties.Add.

◆ GetCount()

long wxAutoExcel::wxExcelDocumentProperties::GetCount ( )

Returns the number of items in the collection.

MSDN documentation for DocumentProperties.Count.

◆ GetItem()

wxExcelDocumentProperty wxAutoExcel::wxExcelDocumentProperties::GetItem ( long index )

Returns a single DocumentProperty object from the collection.

MSDN documentation for DocumentProperties.Item.

◆ begin()

iterator wxAutoExcel::wxExcelDocumentProperties::begin ( )

inline

Returns the iterator referring to the first item, or past the last item, which allows iterating over the items with a range-based for loop, see wxExcelCollectionIterator.

◆ GetAutoExcelObjectName_()

virtual wxString wxAutoExcel::wxExcelDocumentProperties::GetAutoExcelObjectName_ ( ) const

inlinevirtual

Returns "DocumentProperties".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Types

Public Member Functions

Additional Inherited Members