Represents Microsoft Excel Name object. More...

#include <wxAutoExcelNames.h>

Inheritance diagram for wxAutoExcel::wxExcelName:

Public Member Functions
void	Delete ()
	Deletes the object.

wxString	GetCategory ()
	Returns the category for the specified name in the language of the macro.

void	SetCategory (const wxString &category)
	Sets the category for the specified name in the language of the macro.

wxString	GetCategoryLocal ()
	Returns the category for the specified name, in the language of the user, if the name refers to a custom function or command.

void	SetCategoryLocal (const wxString &categoryLocal)
	Sets the category for the specified name, in the language of the user, if the name refers to a custom function or command.

wxString	GetComment ()
	Returns the comment associated with the name.

void	SetComment (const wxString &comment)
	Sets the comment associated with the name.

long	GetIndex ()
	Returns a Long value that represents the index number of the object within the collection of similar objects.

XlXLMMacroType	GetMacroType ()
	Returns what the name refers to.

void	SetMacroType (XlXLMMacroType macroType)
	Sets what the name refers to.

wxString	GetName ()
	Returns a String value representing the name of the object.

void	SetName (const wxString &name)
	Sets a String value representing the name of the object.

wxString	GetNameLocal ()
	Returns the name of the object, in the language of the user.

void	SetNameLocal (const wxString &nameLocal)
	Sets the name of the object, in the language of the user.

wxString	GetRefersTo ()
	Returns the formula that the name is defined to refer to, in the language of the macro and in A1-style notation, beginning with an equal sign.

void	SetRefersTo (const wxString &refersTo)
	Sets the formula that the name is defined to refer to, in the language of the macro and in A1-style notation, beginning with an equal sign.

wxString	GetRefersToLocal ()
	Returns the formula that the name refers to.

void	SetRefersToLocal (const wxString &refersToLocal)
	Sets the formula that the name refers to.

wxString	GetRefersToR1C1 ()
	Returns the formula that the name refers to.

void	SetRefersToR1C1 (const wxString &refersToR1C1)
	Sets the formula that the name refers to.

wxString	GetRefersToR1C1Local ()
	Returns the formula that the name refers to.

void	SetRefersToR1C1Local (const wxString &refersToR1C1Local)
	Sets the formula that the name refers to.

wxExcelRange	GetRefersToRange ()
	Returns the Range object referred to by a Name object.

wxString	GetShortcutKey ()
	Returns the shortcut key for a name defined as a custom Microsoft Excel 4.0 macro command.

void	SetShortcutKey (const wxString &shortcutKey)
	Sets the shortcut key for a name defined as a custom Microsoft Excel 4.0 macro command.

bool	GetValidWorkbookParameter ()
	True if the specified Name object is a valid workbook parameter.

wxString	GetValue ()
	Returns a String value that represents the formula that the name is defined to refer to.

void	SetValue (const wxString &value)
	Sets a String value that represents the formula that the name is defined to refer to.

bool	GetVisible ()
	Returns a Boolean value that determines whether the object is visible.

void	SetVisible (bool visible)
	Sets a Boolean value that determines whether the object is visible.

bool	GetWorkbookParameter ()
	Returns the specified Name object as a workbook parameter.

void	SetWorkbookParameter (bool workbookParameter)
	Sets the specified Name object as a workbook parameter.

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "Name".

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.

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
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.

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 Microsoft Excel Name object.

Member Function Documentation

◆ Delete()

void wxAutoExcel::wxExcelName::Delete ( )

Deletes the object.

MSDN documentation for Name.Delete.

◆ GetCategory()

wxString wxAutoExcel::wxExcelName::GetCategory ( )

Returns the category for the specified name in the language of the macro.

The name must refer to a custom function or command.

MSDN documentation for Name.Category.

◆ SetCategory()

void wxAutoExcel::wxExcelName::SetCategory ( const wxString & category )

Sets the category for the specified name in the language of the macro.

The name must refer to a custom function or command.

MSDN documentation for Name.Category.

◆ GetCategoryLocal()

wxString wxAutoExcel::wxExcelName::GetCategoryLocal ( )

Returns the category for the specified name, in the language of the user, if the name refers to a custom function or command.

MSDN documentation for Name.CategoryLocal.

◆ SetCategoryLocal()

void wxAutoExcel::wxExcelName::SetCategoryLocal ( const wxString & categoryLocal )

Sets the category for the specified name, in the language of the user, if the name refers to a custom function or command.

MSDN documentation for Name.CategoryLocal.

◆ GetComment()

wxString wxAutoExcel::wxExcelName::GetComment ( )

Returns the comment associated with the name.

Since Excel 2007.

MSDN documentation for Name.Comment.

◆ SetComment()

void wxAutoExcel::wxExcelName::SetComment ( const wxString & comment )

Sets the comment associated with the name.

Since Excel 2007.

MSDN documentation for Name.Comment.

◆ GetIndex()

long wxAutoExcel::wxExcelName::GetIndex ( )

Returns a Long value that represents the index number of the object within the collection of similar objects.

MSDN documentation for Name.Index.

◆ GetMacroType()

XlXLMMacroType wxAutoExcel::wxExcelName::GetMacroType ( )

Returns what the name refers to.

Read/write XlXLMMacroType.

MSDN documentation for Name.MacroType.

◆ SetMacroType()

void wxAutoExcel::wxExcelName::SetMacroType ( XlXLMMacroType macroType )

Sets what the name refers to.

Read/write XlXLMMacroType.

MSDN documentation for Name.MacroType.

◆ GetName()

wxString wxAutoExcel::wxExcelName::GetName ( )

Returns a String value representing the name of the object.

MSDN documentation for Name.Name.

◆ SetName()

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

Sets a String value representing the name of the object.

MSDN documentation for Name.Name.

◆ GetNameLocal()

wxString wxAutoExcel::wxExcelName::GetNameLocal ( )

Returns the name of the object, in the language of the user.

MSDN documentation for Name.NameLocal.

◆ SetNameLocal()

void wxAutoExcel::wxExcelName::SetNameLocal ( const wxString & nameLocal )

Sets the name of the object, in the language of the user.

MSDN documentation for Name.NameLocal.

◆ GetRefersTo()

wxString wxAutoExcel::wxExcelName::GetRefersTo ( )

Returns the formula that the name is defined to refer to, in the language of the macro and in A1-style notation, beginning with an equal sign.

MSDN documentation for Name.RefersTo.

◆ SetRefersTo()

void wxAutoExcel::wxExcelName::SetRefersTo ( const wxString & refersTo )

Sets the formula that the name is defined to refer to, in the language of the macro and in A1-style notation, beginning with an equal sign.

MSDN documentation for Name.RefersTo.

◆ GetRefersToLocal()

wxString wxAutoExcel::wxExcelName::GetRefersToLocal ( )

Returns the formula that the name refers to.

The formula is in the language of the user, and it's in A1-style notation, beginning with an equal sign.

MSDN documentation for Name.RefersToLocal.

◆ SetRefersToLocal()

void wxAutoExcel::wxExcelName::SetRefersToLocal ( const wxString & refersToLocal )

Sets the formula that the name refers to.

The formula is in the language of the user, and it's in A1-style notation, beginning with an equal sign.

MSDN documentation for Name.RefersToLocal.

◆ GetRefersToR1C1()

wxString wxAutoExcel::wxExcelName::GetRefersToR1C1 ( )

Returns the formula that the name refers to.

The formula is in the language of the macro, and it's in R1C1-style notation, beginning with an equal sign.

MSDN documentation for Name.RefersToR1C1.

◆ SetRefersToR1C1()

void wxAutoExcel::wxExcelName::SetRefersToR1C1 ( const wxString & refersToR1C1 )

Sets the formula that the name refers to.

The formula is in the language of the macro, and it's in R1C1-style notation, beginning with an equal sign.

MSDN documentation for Name.RefersToR1C1.

◆ GetRefersToR1C1Local()

wxString wxAutoExcel::wxExcelName::GetRefersToR1C1Local ( )

Returns the formula that the name refers to.

This formula is in the language of the user, and it's in R1C1-style notation, beginning with an equal sign.

MSDN documentation for Name.RefersToR1C1Local.

◆ SetRefersToR1C1Local()

void wxAutoExcel::wxExcelName::SetRefersToR1C1Local ( const wxString & refersToR1C1Local )

Sets the formula that the name refers to.

This formula is in the language of the user, and it's in R1C1-style notation, beginning with an equal sign.

MSDN documentation for Name.RefersToR1C1Local.

◆ GetRefersToRange()

wxExcelRange wxAutoExcel::wxExcelName::GetRefersToRange ( )

Returns the Range object referred to by a Name object.

MSDN documentation for Name.RefersToRange.

◆ GetShortcutKey()

wxString wxAutoExcel::wxExcelName::GetShortcutKey ( )

Returns the shortcut key for a name defined as a custom Microsoft Excel 4.0 macro command.

MSDN documentation for Name.ShortcutKey.

◆ SetShortcutKey()

void wxAutoExcel::wxExcelName::SetShortcutKey ( const wxString & shortcutKey )

Sets the shortcut key for a name defined as a custom Microsoft Excel 4.0 macro command.

MSDN documentation for Name.ShortcutKey.

◆ GetValidWorkbookParameter()

bool wxAutoExcel::wxExcelName::GetValidWorkbookParameter ( )

True if the specified Name object is a valid workbook parameter.

Since Excel 2007.

MSDN documentation for Name.ValidWorkbookParameter.

◆ GetValue()

wxString wxAutoExcel::wxExcelName::GetValue ( )

Returns a String value that represents the formula that the name is defined to refer to.

MSDN documentation for Name.Value.

◆ SetValue()

void wxAutoExcel::wxExcelName::SetValue ( const wxString & value )

Sets a String value that represents the formula that the name is defined to refer to.

MSDN documentation for Name.Value.

◆ GetVisible()

bool wxAutoExcel::wxExcelName::GetVisible ( )

Returns a Boolean value that determines whether the object is visible.

MSDN documentation for Name.Visible.

◆ SetVisible()

void wxAutoExcel::wxExcelName::SetVisible ( bool visible )

Sets a Boolean value that determines whether the object is visible.

MSDN documentation for Name.Visible.

◆ GetWorkbookParameter()

bool wxAutoExcel::wxExcelName::GetWorkbookParameter ( )

Returns the specified Name object as a workbook parameter.

Since Excel 2007.

MSDN documentation for Name.WorkbookParameter.

◆ SetWorkbookParameter()

void wxAutoExcel::wxExcelName::SetWorkbookParameter ( bool workbookParameter )

Sets the specified Name object as a workbook parameter.

Since Excel 2007.

MSDN documentation for Name.WorkbookParameter.

◆ GetAutoExcelObjectName_()

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

inlinevirtual

Returns "Name".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Delete()

◆ GetCategory()

◆ SetCategory()

◆ GetCategoryLocal()

◆ SetCategoryLocal()

◆ GetComment()

◆ SetComment()

◆ GetIndex()

◆ GetMacroType()

◆ SetMacroType()

◆ GetName()

◆ SetName()

◆ GetNameLocal()

◆ SetNameLocal()

◆ GetRefersTo()

◆ SetRefersTo()

◆ GetRefersToLocal()

◆ SetRefersToLocal()

◆ GetRefersToR1C1()

◆ SetRefersToR1C1()

◆ GetRefersToR1C1Local()

◆ SetRefersToR1C1Local()

◆ GetRefersToRange()

◆ GetShortcutKey()

◆ SetShortcutKey()

◆ GetValidWorkbookParameter()

◆ GetValue()

◆ SetValue()

◆ GetVisible()

◆ SetVisible()

◆ GetWorkbookParameter()

◆ SetWorkbookParameter()

◆ GetAutoExcelObjectName_()