Represents an object holding all data type properties for ListColumn. More...

#include <wxAutoExcelListDataFormat.h>

Inheritance diagram for wxAutoExcel::wxExcelListDataFormat:

Public Member Functions
bool	GetAllowFillIn ()
	Returns a Boolean value indicating whether users can provide their own data for cells in a column (rather than being restricted to a list of values) for those columns that supply a list of values.

wxArrayString	GetChoices ()
	Returns an Array of String values that contains the choices offered to the user by the ListLookUp, ChoiceMulti, and Choice data types of the DefaultValue property.

long	GetDecimalPlaces ()
	Returns a Long value that represents the number of decimal places to show for the numbers in the ListColumn object.

wxVariant	GetDefaultValue ()
	Returns Variant representing the default data type value for a new row in a column.

bool	GetIsPercent ()
	Returns a Boolean value.

long	Getlcid ()
	Returns a Long value that represents the LCID for the ListColumn object that is specified in the schema definition.

long	GetMaxCharacters ()
	Returns a Long containing the maximum number of characters allowed in the ListColumn object if the Type property is set to xlListDataTypeText or xlListDataTypeMultiLineText.

wxVariant	GetMaxNumber ()
	Returns a Variant containing the maximum value allowed in this field in the list column.

wxVariant	GetMinNumber ()
	Returns a Variant containing the minimum value allowed in this field in the list column.

bool	GetReadOnly ()
	Returns True if the object has been opened as read-only.

bool	GetRequired ()
	Returns a Boolean value indicating whether the schema definition of a column requires data before the row is committed.

XlListDataType	GetType ()
	Returns an XlListDataType value that represents the data type of the list column.

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "ListDataFormat".

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 an object holding all data type properties for ListColumn.

Member Function Documentation

◆ GetAllowFillIn()

bool wxAutoExcel::wxExcelListDataFormat::GetAllowFillIn ( )

Returns a Boolean value indicating whether users can provide their own data for cells in a column (rather than being restricted to a list of values) for those columns that supply a list of values.

Returns False for lists that are not linked to a SharePoint site. Also returns False if the column is not a specified as choice or multi-choice.

MSDN documentation for ListDataFormat.AllowFillIn

◆ GetChoices()

wxArrayString wxAutoExcel::wxExcelListDataFormat::GetChoices ( )

Returns an Array of String values that contains the choices offered to the user by the ListLookUp, ChoiceMulti, and Choice data types of the DefaultValue property.

MSDN documentation for ListDataFormat.Choices

◆ GetDecimalPlaces()

long wxAutoExcel::wxExcelListDataFormat::GetDecimalPlaces ( )

Returns a Long value that represents the number of decimal places to show for the numbers in the ListColumn object.

MSDN documentation for ListDataFormat.DecimalPlaces

◆ GetDefaultValue()

wxVariant wxAutoExcel::wxExcelListDataFormat::GetDefaultValue ( )

Returns Variant representing the default data type value for a new row in a column.

The Nothing object is returned when the schema does not specify a default value.

MSDN documentation for ListDataFormat.DefaultValue

◆ GetIsPercent()

bool wxAutoExcel::wxExcelListDataFormat::GetIsPercent ( )

Returns a Boolean value.

Returns True only if the number data for the ListColumn object will be shown in percentage formatting.

MSDN documentation for ListDataFormat.IsPercent

◆ Getlcid()

long wxAutoExcel::wxExcelListDataFormat::Getlcid ( )

Returns a Long value that represents the LCID for the ListColumn object that is specified in the schema definition.

MSDN documentation for ListDataFormat.lcid

◆ GetMaxCharacters()

long wxAutoExcel::wxExcelListDataFormat::GetMaxCharacters ( )

Returns a Long containing the maximum number of characters allowed in the ListColumn object if the Type property is set to xlListDataTypeText or xlListDataTypeMultiLineText.

MSDN documentation for ListDataFormat.MaxCharacters