Represents Microsoft Excel LineFormat object. More...

#include <wxAutoExcelLineFormat.h>

Inheritance diagram for wxAutoExcel::wxExcelLineFormat:

Public Member Functions
wxExcelColorFormat	GetBackColor ()
	Returns a ColorFormat Represents the specified fill background color.

MsoArrowheadLength	GetBeginArrowheadLength ()
	Returns the length of the arrowhead at the beginning of the specified line.

void	SetBeginArrowheadLength (MsoArrowheadLength beginArrowheadLength)
	Sets the length of the arrowhead at the beginning of the specified line.

MsoArrowheadStyle	GetBeginArrowheadStyle ()
	Returns the style of the arrowhead at the beginning of the specified line.

void	SetBeginArrowheadStyle (MsoArrowheadStyle beginArrowheadStyle)
	Sets the style of the arrowhead at the beginning of the specified line.

MsoArrowheadWidth	GetBeginArrowheadWidth ()
	Returns the width of the arrowhead at the beginning of the specified line.

void	SetBeginArrowheadWidth (MsoArrowheadWidth beginArrowheadWidth)
	Sets the width of the arrowhead at the beginning of the specified line.

MsoLineDashStyle	GetDashStyle ()
	Returns the dash style for the specified line.

void	SetDashStyle (MsoLineDashStyle dashStyle)
	Sets the dash style for the specified line.

MsoArrowheadLength	GetEndArrowheadLength ()
	Returns the length of the arrowhead at the end of the specified line.

void	SetEndArrowheadLength (MsoArrowheadLength endArrowheadLength)
	Sets the length of the arrowhead at the end of the specified line.

MsoArrowheadStyle	GetEndArrowheadStyle ()
	Returns the style of the arrowhead at the end of the specified line.

void	SetEndArrowheadStyle (MsoArrowheadStyle endArrowheadStyle)
	Sets the style of the arrowhead at the end of the specified line.

MsoArrowheadWidth	GetEndArrowheadWidth ()
	Returns the width of the arrowhead at the end of the specified line.

void	SetEndArrowheadWidth (MsoArrowheadWidth endArrowheadWidth)
	Sets the width of the arrowhead at the end of the specified line.

wxExcelColorFormat	GetForeColor ()
	Returns a ColorFormat Represents the specified foreground fill or solid color.

void	SetForeColor (const wxExcelColorFormat &foreColor)
	Sets a ColorFormat Represents the specified foreground fill or solid color.

MsoTriState	GetInsetPen ()
	Whether lines are drawn inside the specified shape's boundaries.

void	SetInsetPen (MsoTriState insetPen)
	Whether lines are drawn inside the specified shape's boundaries.

MsoPatternType	GetPattern ()
	Returns an MsoPatternType value that represents the fill pattern.

void	SetPattern (MsoPatternType pattern)
	Sets an MsoPatternType value that represents the fill pattern.

MsoLineStyle	GetStyle ()
	Returns a MsoLineStyle value that represents the style of the line.

void	SetStyle (MsoLineStyle style)
	Sets a MsoLineStyle value that represents the style of the line.

double	GetTransparency ()
	Returns the degree of transparency of the specified fill as a value from 0.0 (opaque) through 1.0 (clear).

void	SetTransparency (double transparency)
	Sets the degree of transparency of the specified fill as a value from 0.0 (opaque) through 1.0 (clear).

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

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

double	GetWeight ()
	Returns a Single value that represents the weight of the line.

void	SetWeight (double weight)
	Sets a Single value that represents the weight of the line.

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "LineFormat".

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

Member Function Documentation

◆ GetBackColor()

wxExcelColorFormat wxAutoExcel::wxExcelLineFormat::GetBackColor ( )

Returns a ColorFormat Represents the specified fill background color.

MSDN documentation for LineFormat.BackColor.

◆ GetBeginArrowheadLength()

MsoArrowheadLength wxAutoExcel::wxExcelLineFormat::GetBeginArrowheadLength ( )

Returns the length of the arrowhead at the beginning of the specified line.

Read/write MsoArrowheadLength.

MSDN documentation for LineFormat.BeginArrowheadLength.

◆ SetBeginArrowheadLength()

void wxAutoExcel::wxExcelLineFormat::SetBeginArrowheadLength ( MsoArrowheadLength beginArrowheadLength )

Sets the length of the arrowhead at the beginning of the specified line.

Read/write MsoArrowheadLength.

MSDN documentation for LineFormat.BeginArrowheadLength.

◆ GetBeginArrowheadStyle()

MsoArrowheadStyle wxAutoExcel::wxExcelLineFormat::GetBeginArrowheadStyle ( )

Returns the style of the arrowhead at the beginning of the specified line.

Read/write MsoArrowheadStyle.

MSDN documentation for LineFormat.BeginArrowheadStyle.

◆ SetBeginArrowheadStyle()

void wxAutoExcel::wxExcelLineFormat::SetBeginArrowheadStyle ( MsoArrowheadStyle beginArrowheadStyle )

Sets the style of the arrowhead at the beginning of the specified line.

Read/write MsoArrowheadStyle.

MSDN documentation for LineFormat.BeginArrowheadStyle.

◆ GetBeginArrowheadWidth()

MsoArrowheadWidth wxAutoExcel::wxExcelLineFormat::GetBeginArrowheadWidth ( )

Returns the width of the arrowhead at the beginning of the specified line.

Read/write MsoArrowheadWidth.

MSDN documentation for LineFormat.BeginArrowheadWidth.

◆ SetBeginArrowheadWidth()

void wxAutoExcel::wxExcelLineFormat::SetBeginArrowheadWidth ( MsoArrowheadWidth beginArrowheadWidth )

Sets the width of the arrowhead at the beginning of the specified line.

Read/write MsoArrowheadWidth.

MSDN documentation for LineFormat.BeginArrowheadWidth.

◆ GetDashStyle()

MsoLineDashStyle wxAutoExcel::wxExcelLineFormat::GetDashStyle ( )

Returns the dash style for the specified line.

Can be one of the MsoLineDashStyle contants.

MSDN documentation for LineFormat.DashStyle.

◆ SetDashStyle()

void wxAutoExcel::wxExcelLineFormat::SetDashStyle ( MsoLineDashStyle dashStyle )

Sets the dash style for the specified line.

Can be one of the MsoLineDashStyle contants.

MSDN documentation for LineFormat.DashStyle.

◆ GetEndArrowheadLength()

MsoArrowheadLength wxAutoExcel::wxExcelLineFormat::GetEndArrowheadLength ( )

Returns the length of the arrowhead at the end of the specified line.

Read/write MsoArrowheadLength.

MSDN documentation for LineFormat.EndArrowheadLength.

◆ SetEndArrowheadLength()

void wxAutoExcel::wxExcelLineFormat::SetEndArrowheadLength ( MsoArrowheadLength endArrowheadLength )

Sets the length of the arrowhead at the end of the specified line.

Read/write MsoArrowheadLength.

MSDN documentation for LineFormat.EndArrowheadLength.

◆ GetEndArrowheadStyle()

MsoArrowheadStyle wxAutoExcel::wxExcelLineFormat::GetEndArrowheadStyle ( )

Returns the style of the arrowhead at the end of the specified line.

Read/write MsoArrowheadStyle.

MSDN documentation for LineFormat.EndArrowheadStyle.

◆ SetEndArrowheadStyle()

void wxAutoExcel::wxExcelLineFormat::SetEndArrowheadStyle ( MsoArrowheadStyle endArrowheadStyle )

Sets the style of the arrowhead at the end of the specified line.

Read/write MsoArrowheadStyle.

MSDN documentation for LineFormat.EndArrowheadStyle.

◆ GetEndArrowheadWidth()

MsoArrowheadWidth wxAutoExcel::wxExcelLineFormat::GetEndArrowheadWidth ( )

Returns the width of the arrowhead at the end of the specified line.

Read/write MsoArrowheadWidth.

MSDN documentation for LineFormat.EndArrowheadWidth.

◆ SetEndArrowheadWidth()

void wxAutoExcel::wxExcelLineFormat::SetEndArrowheadWidth ( MsoArrowheadWidth endArrowheadWidth )

Sets the width of the arrowhead at the end of the specified line.

Read/write MsoArrowheadWidth.

MSDN documentation for LineFormat.EndArrowheadWidth.

◆ GetForeColor()

wxExcelColorFormat wxAutoExcel::wxExcelLineFormat::GetForeColor ( )

Returns a ColorFormat Represents the specified foreground fill or solid color.

MSDN documentation for LineFormat.ForeColor.

◆ SetForeColor()

void wxAutoExcel::wxExcelLineFormat::SetForeColor ( const wxExcelColorFormat & foreColor )

Sets a ColorFormat Represents the specified foreground fill or solid color.

MSDN documentation for LineFormat.ForeColor.

◆ GetInsetPen()

MsoTriState wxAutoExcel::wxExcelLineFormat::GetInsetPen ( )

Whether lines are drawn inside the specified shape's boundaries.

Since Excel 2010.

MSDN documentation for LineFormat.InsetPen.

◆ SetInsetPen()

void wxAutoExcel::wxExcelLineFormat::SetInsetPen ( MsoTriState insetPen )

Whether lines are drawn inside the specified shape's boundaries.

Since Excel 2010.

MSDN documentation for LineFormat.InsetPen.

◆ GetPattern()

MsoPatternType wxAutoExcel::wxExcelLineFormat::GetPattern ( )

Returns an MsoPatternType value that represents the fill pattern.

MSDN documentation for LineFormat.Pattern.

◆ SetPattern()

void wxAutoExcel::wxExcelLineFormat::SetPattern ( MsoPatternType pattern )

Sets an MsoPatternType value that represents the fill pattern.

MSDN documentation for LineFormat.Pattern.

◆ GetStyle()

MsoLineStyle wxAutoExcel::wxExcelLineFormat::GetStyle ( )

Returns a MsoLineStyle value that represents the style of the line.

MSDN documentation for LineFormat.Style.

◆ SetStyle()

void wxAutoExcel::wxExcelLineFormat::SetStyle ( MsoLineStyle style )

Sets a MsoLineStyle value that represents the style of the line.

MSDN documentation for LineFormat.Style.

◆ GetTransparency()

double wxAutoExcel::wxExcelLineFormat::GetTransparency ( )

Returns the degree of transparency of the specified fill as a value from 0.0 (opaque) through 1.0 (clear).

Read/write Double.

MSDN documentation for LineFormat.Transparency.

◆ SetTransparency()

void wxAutoExcel::wxExcelLineFormat::SetTransparency ( double transparency )

Sets the degree of transparency of the specified fill as a value from 0.0 (opaque) through 1.0 (clear).

Read/write Double.

MSDN documentation for LineFormat.Transparency.

◆ GetVisible()

MsoTriState wxAutoExcel::wxExcelLineFormat::GetVisible ( )

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

MSDN documentation for LineFormat.Visible.

◆ SetVisible()

void wxAutoExcel::wxExcelLineFormat::SetVisible ( MsoTriState visible )

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

MSDN documentation for LineFormat.Visible.

◆ GetWeight()

double wxAutoExcel::wxExcelLineFormat::GetWeight ( )

Returns a Single value that represents the weight of the line.

MSDN documentation for LineFormat.Weight.

◆ SetWeight()

void wxAutoExcel::wxExcelLineFormat::SetWeight ( double weight )

Sets a Single value that represents the weight of the line.

MSDN documentation for LineFormat.Weight.

◆ GetAutoExcelObjectName_()

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

inlinevirtual

Returns "LineFormat".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetBackColor()

◆ GetBeginArrowheadLength()

◆ SetBeginArrowheadLength()

◆ GetBeginArrowheadStyle()

◆ SetBeginArrowheadStyle()

◆ GetBeginArrowheadWidth()

◆ SetBeginArrowheadWidth()

◆ GetDashStyle()

◆ SetDashStyle()

◆ GetEndArrowheadLength()

◆ SetEndArrowheadLength()

◆ GetEndArrowheadStyle()

◆ SetEndArrowheadStyle()

◆ GetEndArrowheadWidth()

◆ SetEndArrowheadWidth()

◆ GetForeColor()

◆ SetForeColor()

◆ GetInsetPen()

◆ SetInsetPen()

◆ GetPattern()

◆ SetPattern()

◆ GetStyle()

◆ SetStyle()

◆ GetTransparency()

◆ SetTransparency()

◆ GetVisible()

◆ SetVisible()

◆ GetWeight()

◆ SetWeight()

◆ GetAutoExcelObjectName_()