Represents the display settings for an associated Range object. More...

Inheritance diagram for wxAutoExcel::wxExcelDisplayFormat:

Public Member Functions
bool	GetAddIndent ()
	Returns a value that indicates if Microsoft Excel automatically indents text of the associated Range object when the text alignment in a cell is set to equal distribution (either horizontally or vertically), as it is displayed in the current user interface. More...

wxExcelBorders	GetBorders ()
	Returns a Borders object that represents the borders of the associated Range object as it is displayed in the current user interface. More...

wxExcelCharacters	GetCharacters (long start=1, long *length=NULL)
	Returns a Characters object that represents a range of characters within the text of the associated Range object as it is displayed in the current user interface. More...

wxExcelFont	GetFont ()
	Returns a Font object that represents the font of the associated Range as it is displayed in the current user interface. More...

wxXlTribool	GetFormulaHidden ()
	Whether the formula will be hidden when the worksheet is protected. More...

long	GetHorizontalAlignment ()
	Returns a value that represents the horizontal alignment of the associated Range object as it is displayed in the current user interface. More...

long	GetIndentLevel ()
	Returns a value that represents the indent level of the associated Range object as it is displayed in the current user interface. More...

wxExcelInterior	GetInterior ()
	Returns an Interior object that represents the interior of the associated Range object as it is displayed in the current user interface. More...

wxXlTribool	GetLocked ()
	Returns `tb_true` if all cells in the range are locked, `tb_true` if all cells in the range are unlocked, and `tb_default` is some cells are locked and some are not. More...

bool	GetMergeCells ()
	Returns a value that indicates if the associated Range object contains merged cells as it is displayed in the current user interface. More...

wxString	GetNumberFormat ()
	Returns the format code for the range or an empty string if all the cells in range don't share the same format. More...

wxString	GetNumberFormatLocal ()
	Returns a value that represents the format code of the associated Range as a string in the language of the user as it is displayed in the current user interface or an empty string if all the cells in range don't share the same format. More...

long	GetOrientation ()
	Returns a value that represents the text orientation of the associated Range object as it is displayed in the current user interface. More...

long	GetReadingOrder ()
	Returns the reading order of the associated Range object as it is displayed in the current user interface. More...

wxXlTribool	GetShrinkToFit ()
	Returns `tb_true` if the text shrinks to fit into the cell in all cells in the range. More...

wxExcelStyle	GetStyle ()
	Returns a value, containing a Style object, that represents the style of the associated Range object as it is displayed in the current user interface. More...

long	GetVerticalAlignment ()
	Returns a value that represents the vertical alignment of the associated Range object as it is displayed in the current user interface. More...

wxXlTribool	GetWrapText ()
	Returns `tb_true` if all cells in the range wrap the text, `tb_false` if all cells in the range do not wrap the text, and `tb_default` if some cells wrap the text and some do not. More...

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "DisplayFormat". 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 the display settings for an associated Range object.

Member Function Documentation

◆ GetAddIndent()

bool wxAutoExcel::wxExcelDisplayFormat::GetAddIndent ( )

Returns a value that indicates if Microsoft Excel automatically indents text of the associated Range object when the text alignment in a cell is set to equal distribution (either horizontally or vertically), as it is displayed in the current user interface.

Excel VBA documentation for DisplayFormat.AddIndent

◆ GetBorders()

wxExcelBorders wxAutoExcel::wxExcelDisplayFormat::GetBorders ( )

Returns a Borders object that represents the borders of the associated Range object as it is displayed in the current user interface.

Excel VBA documentation for DisplayFormat.Borders

◆ GetCharacters()

wxExcelCharacters wxAutoExcel::wxExcelDisplayFormat::GetCharacters	(	long	start = `1`,
		long *	length = `NULL`
	)

Returns a Characters object that represents a range of characters within the text of the associated Range object as it is displayed in the current user interface.

Excel VBA documentation for DisplayFormat.Characters

◆ GetFont()

wxExcelFont wxAutoExcel::wxExcelDisplayFormat::GetFont ( )

Returns a Font object that represents the font of the associated Range as it is displayed in the current user interface.

Excel VBA documentation for DisplayFormat.Font

◆ GetFormulaHidden()

wxXlTribool wxAutoExcel::wxExcelDisplayFormat::GetFormulaHidden ( )

Whether the formula will be hidden when the worksheet is protected.

Returns tb_true if all cells in the range have this property set to true, tb_false if all cells in the range have this property set to false, and tb_default if the value of this property is not same for all cells in the range.

Excel VBA documentation for DisplayFormat.FormulaHidden

◆ GetHorizontalAlignment()

long wxAutoExcel::wxExcelDisplayFormat::GetHorizontalAlignment ( )

Returns a value that represents the horizontal alignment of the associated Range object as it is displayed in the current user interface.

Excel VBA documentation for DisplayFormat.HorizontalAlignment

◆ GetIndentLevel()

long wxAutoExcel::wxExcelDisplayFormat::GetIndentLevel ( )

Returns a value that represents the indent level of the associated Range object as it is displayed in the current user interface.

Excel VBA documentation for DisplayFormat.IndentLevel

◆ GetInterior()

wxExcelInterior wxAutoExcel::wxExcelDisplayFormat::GetInterior ( )

Returns an Interior object that represents the interior of the associated Range object as it is displayed in the current user interface.

Excel VBA documentation for DisplayFormat.Interior

◆ GetLocked()

wxXlTribool wxAutoExcel::wxExcelDisplayFormat::GetLocked ( )

Returns tb_true if all cells in the range are locked, tb_true if all cells in the range are unlocked, and tb_default is some cells are locked and some are not.

Excel VBA documentation for DisplayFormat.Locked

◆ GetMergeCells()

bool wxAutoExcel::wxExcelDisplayFormat::GetMergeCells ( )

Returns a value that indicates if the associated Range object contains merged cells as it is displayed in the current user interface.

Excel VBA documentation for DisplayFormat.MergeCells

◆ GetNumberFormat()

wxString wxAutoExcel::wxExcelDisplayFormat::GetNumberFormat ( )

Returns the format code for the range or an empty string if all the cells in range don't share the same format.

Excel VBA documentation for DisplayFormat.NumberFormat

◆ GetNumberFormatLocal()

wxString wxAutoExcel::wxExcelDisplayFormat::GetNumberFormatLocal ( )

Returns a value that represents the format code of the associated Range as a string in the language of the user as it is displayed in the current user interface or an empty string if all the cells in range don't share the same format.

Excel VBA documentation for DisplayFormat.NumberFormatLocal

◆ GetOrientation()

long wxAutoExcel::wxExcelDisplayFormat::GetOrientation ( )

Returns a value that represents the text orientation of the associated Range object as it is displayed in the current user interface.

Excel VBA documentation for DisplayFormat.Orientation

◆ GetReadingOrder()

long wxAutoExcel::wxExcelDisplayFormat::GetReadingOrder ( )

Returns the reading order of the associated Range object as it is displayed in the current user interface.

Excel VBA documentation for DisplayFormat.ReadingOrder

◆ GetShrinkToFit()

wxXlTribool wxAutoExcel::wxExcelDisplayFormat::GetShrinkToFit ( )

Returns tb_true if the text shrinks to fit into the cell in all cells in the range.

Returns tb_default if this property is not the same in all cells in the range.

Excel VBA documentation for DisplayFormat.ShrinkToFit

◆ GetStyle()

wxExcelStyle wxAutoExcel::wxExcelDisplayFormat::GetStyle ( )

Returns a value, containing a Style object, that represents the style of the associated Range object as it is displayed in the current user interface.

Excel VBA documentation for DisplayFormat.Style

◆ GetVerticalAlignment()

long wxAutoExcel::wxExcelDisplayFormat::GetVerticalAlignment ( )

Returns a value that represents the vertical alignment of the associated Range object as it is displayed in the current user interface.

Excel VBA documentation for DisplayFormat.VerticalAlignment

◆ GetWrapText()

wxXlTribool wxAutoExcel::wxExcelDisplayFormat::GetWrapText ( )

Returns tb_true if all cells in the range wrap the text, tb_false if all cells in the range do not wrap the text, and tb_default if some cells wrap the text and some do not.

Excel VBA documentation for DisplayFormat.WrapText

◆ GetAutoExcelObjectName_()

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

inlinevirtual

Returns "DisplayFormat".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Member Functions

Additional Inherited Members