wxAutoExcel  2.0.0
wxAutoExcel::wxExcelBulletFormat2 Class Reference

Represents Microsoft Excel BulletFormat2 object. More...

Inheritance diagram for wxAutoExcel::wxExcelBulletFormat2:
wxAutoExcel::wxExcelObject

Public Member Functions

void Picture (const wxString &fileName)
 Sets the graphics file to be used for bullets in a bulleted list. More...
 
long GetCharacter ()
 Gets or sets the Unicode character value that is used for bullets in the specified text. More...
 
void SetCharacter (long character)
 Gets or sets the Unicode character value that is used for bullets in the specified text. More...
 
wxExcelFont2 GetFont ()
 Gets a Font2 Represents character formatting for a BulletFormat2 object. More...
 
long GetNumber ()
 Gets the bullet number of a paragraph. More...
 
double GetRelativeSize ()
 Returns the bullet size relative to the size of the first text character in the paragraph. More...
 
void SetRelativeSize (double relativeSize)
 Sets the bullet size relative to the size of the first text character in the paragraph. More...
 
long GetStartValue ()
 Gets or sets the beginning value of a bulleted list. More...
 
void SetStartValue (long startValue)
 Gets or sets the beginning value of a bulleted list. More...
 
MsoNumberedBulletStyle GetStyle ()
 Returns a constant that represents the style of a bullet. More...
 
void SetStyle (MsoNumberedBulletStyle style)
 Sets a constant that represents the style of a bullet. More...
 
MsoBulletType GetType ()
 Gets or sets a constant that represents the type of bullet. More...
 
void SetType (MsoBulletType type)
 Gets or sets a constant that represents the type of bullet. More...
 
MsoTriState GetUseTextColor ()
 Determines whether the specified bullets are set to the color of the first text character in the paragraph. More...
 
void SetUseTextColor (MsoTriState useTextColor)
 Determines whether the specified bullets are set to the color of the first text character in the paragraph. More...
 
MsoTriState GetUseTextFont ()
 Determines whether the specified bullets are set to the font of the first text character in the paragraph. More...
 
void SetUseTextFont (MsoTriState useTextFont)
 Determines whether the specified bullets are set to the font of the first text character in the paragraph. More...
 
MsoTriState GetVisible ()
 Gets or sets a value that specifies whether the bullet is visible. More...
 
void SetVisible (MsoTriState visible)
 Gets or sets a value that specifies whether the bullet is visible. More...
 
virtual wxString GetAutoExcelObjectName_ () const
 Returns "BulletFormat2". 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 Microsoft Excel BulletFormat2 object.

Member Function Documentation

◆ Picture()

void wxAutoExcel::wxExcelBulletFormat2::Picture ( const wxString &  fileName)

Sets the graphics file to be used for bullets in a bulleted list.

MSDN documentation for BulletFormat2.Picture.

◆ GetCharacter()

long wxAutoExcel::wxExcelBulletFormat2::GetCharacter ( )

Gets or sets the Unicode character value that is used for bullets in the specified text.

MSDN documentation for BulletFormat2.Character.

◆ SetCharacter()

void wxAutoExcel::wxExcelBulletFormat2::SetCharacter ( long  character)

Gets or sets the Unicode character value that is used for bullets in the specified text.

MSDN documentation for BulletFormat2.Character.

◆ GetFont()

wxExcelFont2 wxAutoExcel::wxExcelBulletFormat2::GetFont ( )

Gets a Font2 Represents character formatting for a BulletFormat2 object.

MSDN documentation for BulletFormat2.Font.

◆ GetNumber()

long wxAutoExcel::wxExcelBulletFormat2::GetNumber ( )

Gets the bullet number of a paragraph.

MSDN documentation for BulletFormat2.Number.

◆ GetRelativeSize()

double wxAutoExcel::wxExcelBulletFormat2::GetRelativeSize ( )

Returns the bullet size relative to the size of the first text character in the paragraph.

MSDN documentation for BulletFormat2.RelativeSize.

◆ SetRelativeSize()

void wxAutoExcel::wxExcelBulletFormat2::SetRelativeSize ( double  relativeSize)

Sets the bullet size relative to the size of the first text character in the paragraph.

MSDN documentation for BulletFormat2.RelativeSize.

◆ GetStartValue()

long wxAutoExcel::wxExcelBulletFormat2::GetStartValue ( )

Gets or sets the beginning value of a bulleted list.

MSDN documentation for BulletFormat2.StartValue.

◆ SetStartValue()

void wxAutoExcel::wxExcelBulletFormat2::SetStartValue ( long  startValue)

Gets or sets the beginning value of a bulleted list.

MSDN documentation for BulletFormat2.StartValue.

◆ GetStyle()

MsoNumberedBulletStyle wxAutoExcel::wxExcelBulletFormat2::GetStyle ( )

Returns a constant that represents the style of a bullet.

MSDN documentation for BulletFormat2.Style.

◆ SetStyle()

void wxAutoExcel::wxExcelBulletFormat2::SetStyle ( MsoNumberedBulletStyle  style)

Sets a constant that represents the style of a bullet.

MSDN documentation for BulletFormat2.Style.

◆ GetType()

MsoBulletType wxAutoExcel::wxExcelBulletFormat2::GetType ( )

Gets or sets a constant that represents the type of bullet.

MSDN documentation for BulletFormat2.Type.

◆ SetType()

void wxAutoExcel::wxExcelBulletFormat2::SetType ( MsoBulletType  type)

Gets or sets a constant that represents the type of bullet.

MSDN documentation for BulletFormat2.Type.

◆ GetUseTextColor()

MsoTriState wxAutoExcel::wxExcelBulletFormat2::GetUseTextColor ( )

Determines whether the specified bullets are set to the color of the first text character in the paragraph.

MSDN documentation for BulletFormat2.UseTextColor.

◆ SetUseTextColor()

void wxAutoExcel::wxExcelBulletFormat2::SetUseTextColor ( MsoTriState  useTextColor)

Determines whether the specified bullets are set to the color of the first text character in the paragraph.

MSDN documentation for BulletFormat2.UseTextColor.

◆ GetUseTextFont()

MsoTriState wxAutoExcel::wxExcelBulletFormat2::GetUseTextFont ( )

Determines whether the specified bullets are set to the font of the first text character in the paragraph.

MSDN documentation for BulletFormat2.UseTextFont.

◆ SetUseTextFont()

void wxAutoExcel::wxExcelBulletFormat2::SetUseTextFont ( MsoTriState  useTextFont)

Determines whether the specified bullets are set to the font of the first text character in the paragraph.

MSDN documentation for BulletFormat2.UseTextFont.

◆ GetVisible()

MsoTriState wxAutoExcel::wxExcelBulletFormat2::GetVisible ( )

Gets or sets a value that specifies whether the bullet is visible.

MSDN documentation for BulletFormat2.Visible.

◆ SetVisible()

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

Gets or sets a value that specifies whether the bullet is visible.

MSDN documentation for BulletFormat2.Visible.

◆ GetAutoExcelObjectName_()

virtual wxString wxAutoExcel::wxExcelBulletFormat2::GetAutoExcelObjectName_ ( ) const
inlinevirtual

Returns "BulletFormat2".

Reimplemented from wxAutoExcel::wxExcelObject.