wxAutoExcel  2.0.0
wxAutoExcel::wxExcelShadowFormat Class Reference

Represents Microsoft Excel ShadowFormat object. More...

Inheritance diagram for wxAutoExcel::wxExcelShadowFormat:
wxAutoExcel::wxExcelObject

Public Member Functions

double GetBlur ()
 Returns the degree of blurriness of the specified shadow. More...
 
void SetBlur (double blur)
 Sets the degree of blurriness of the specified shadow. More...
 
wxExcelColorFormat GetForeColor ()
 Returns a ColorFormat Represents the specified foreground fill or solid color. More...
 
void SetForeColor (const wxExcelColorFormat &foreColor)
 Sets a ColorFormat Represents the specified foreground fill or solid color. More...
 
MsoTriState GetObscured ()
 True if the shadow of the specified shape appears filled in and is obscured by the shape, even if the shape has no fill. More...
 
void SetObscured (MsoTriState obscured)
 True if the shadow of the specified shape appears filled in and is obscured by the shape, even if the shape has no fill. More...
 
double GetOffsetX ()
 Returns the horizontal offset of the shadow from the specified shape, in points. More...
 
void SetOffsetX (double offsetX)
 Sets the horizontal offset of the shadow from the specified shape, in points. More...
 
double GetOffsetY ()
 Returns the vertical offset of the shadow from the specified shape, in points. More...
 
void SetOffsetY (double offsetY)
 Sets the vertical offset of the shadow from the specified shape, in points. More...
 
MsoTriState GetRotateWithShape ()
 Returns an MsoTriState that represents whether to rotate the shadow when rotating the shape. More...
 
void SetRotateWithShape (MsoTriState rotateWithShape)
 Sets an MsoTriState that represents whether to rotate the shadow when rotating the shape. More...
 
double GetSize ()
 Returns the size of the specified shadow. More...
 
void SetSize (double size)
 Sets the size of the specified shadow. More...
 
MsoShadowStyle GetStyle ()
 Returns the style of the specified shadow. More...
 
void SetStyle (MsoShadowStyle style)
 Sets the style of the specified shadow. More...
 
double GetTransparency ()
 Returns the degree of transparency of the specified fill as a value from 0.0 (opaque) through 1.0 (clear). More...
 
void SetTransparency (double transparency)
 Sets the degree of transparency of the specified fill as a value from 0.0 (opaque) through 1.0 (clear). More...
 
MsoShadowType GetType ()
 Returns a MsoShadowType value that represents the shadow format type. More...
 
void SetType (MsoShadowType type)
 Sets a MsoShadowType value that represents the shadow format type. More...
 
MsoTriState GetVisible ()
 Returns a MsoTriState value that determines whether the object is visible. More...
 
void SetVisible (MsoTriState visible)
 Sets a MsoTriState value that determines whether the object is visible. More...
 
virtual wxString GetAutoExcelObjectName_ () const
 Returns "ShadowFormat". 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 ShadowFormat object.

Member Function Documentation

◆ GetBlur()

double wxAutoExcel::wxExcelShadowFormat::GetBlur ( )

Returns the degree of blurriness of the specified shadow.

Since Excel 2007.

MSDN documentation for ShadowFormat.Blur.

◆ SetBlur()

void wxAutoExcel::wxExcelShadowFormat::SetBlur ( double  blur)

Sets the degree of blurriness of the specified shadow.

Since Excel 2007.

MSDN documentation for ShadowFormat.Blur.

◆ GetForeColor()

wxExcelColorFormat wxAutoExcel::wxExcelShadowFormat::GetForeColor ( )

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

MSDN documentation for ShadowFormat.ForeColor.

◆ SetForeColor()

void wxAutoExcel::wxExcelShadowFormat::SetForeColor ( const wxExcelColorFormat foreColor)

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

MSDN documentation for ShadowFormat.ForeColor.

◆ GetObscured()

MsoTriState wxAutoExcel::wxExcelShadowFormat::GetObscured ( )

True if the shadow of the specified shape appears filled in and is obscured by the shape, even if the shape has no fill.

False if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill. Read/write MsoTriState.

MSDN documentation for ShadowFormat.Obscured.

◆ SetObscured()

void wxAutoExcel::wxExcelShadowFormat::SetObscured ( MsoTriState  obscured)

True if the shadow of the specified shape appears filled in and is obscured by the shape, even if the shape has no fill.

False if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill. Read/write MsoTriState.

MSDN documentation for ShadowFormat.Obscured.

◆ GetOffsetX()

double wxAutoExcel::wxExcelShadowFormat::GetOffsetX ( )

Returns the horizontal offset of the shadow from the specified shape, in points.

A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left. Read/write Single.

MSDN documentation for ShadowFormat.OffsetX.

◆ SetOffsetX()

void wxAutoExcel::wxExcelShadowFormat::SetOffsetX ( double  offsetX)

Sets the horizontal offset of the shadow from the specified shape, in points.

A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left. Read/write Single.

MSDN documentation for ShadowFormat.OffsetX.

◆ GetOffsetY()

double wxAutoExcel::wxExcelShadowFormat::GetOffsetY ( )

Returns the vertical offset of the shadow from the specified shape, in points.

A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left. Read/write Single.

MSDN documentation for ShadowFormat.OffsetY.

◆ SetOffsetY()

void wxAutoExcel::wxExcelShadowFormat::SetOffsetY ( double  offsetY)

Sets the vertical offset of the shadow from the specified shape, in points.

A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left. Read/write Single.

MSDN documentation for ShadowFormat.OffsetY.

◆ GetRotateWithShape()

MsoTriState wxAutoExcel::wxExcelShadowFormat::GetRotateWithShape ( )

Returns an MsoTriState that represents whether to rotate the shadow when rotating the shape.

Since Excel 2007.

MSDN documentation for ShadowFormat.RotateWithShape.

◆ SetRotateWithShape()

void wxAutoExcel::wxExcelShadowFormat::SetRotateWithShape ( MsoTriState  rotateWithShape)

Sets an MsoTriState that represents whether to rotate the shadow when rotating the shape.

Since Excel 2007.

MSDN documentation for ShadowFormat.RotateWithShape.

◆ GetSize()

double wxAutoExcel::wxExcelShadowFormat::GetSize ( )

Returns the size of the specified shadow.

Since Excel 2007.

MSDN documentation for ShadowFormat.Size.

◆ SetSize()

void wxAutoExcel::wxExcelShadowFormat::SetSize ( double  size)

Sets the size of the specified shadow.

Since Excel 2007.

MSDN documentation for ShadowFormat.Size.

◆ GetStyle()

MsoShadowStyle wxAutoExcel::wxExcelShadowFormat::GetStyle ( )

Returns the style of the specified shadow.

Since Excel 2007.

MSDN documentation for ShadowFormat.Style.

◆ SetStyle()

void wxAutoExcel::wxExcelShadowFormat::SetStyle ( MsoShadowStyle  style)

Sets the style of the specified shadow.

Since Excel 2007.

MSDN documentation for ShadowFormat.Style.

◆ GetTransparency()

double wxAutoExcel::wxExcelShadowFormat::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 ShadowFormat.Transparency.

◆ SetTransparency()

void wxAutoExcel::wxExcelShadowFormat::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 ShadowFormat.Transparency.

◆ GetType()

MsoShadowType wxAutoExcel::wxExcelShadowFormat::GetType ( )

Returns a MsoShadowType value that represents the shadow format type.

MSDN documentation for ShadowFormat.Type.

◆ SetType()

void wxAutoExcel::wxExcelShadowFormat::SetType ( MsoShadowType  type)

Sets a MsoShadowType value that represents the shadow format type.

MSDN documentation for ShadowFormat.Type.

◆ GetVisible()

MsoTriState wxAutoExcel::wxExcelShadowFormat::GetVisible ( )

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

MSDN documentation for ShadowFormat.Visible.

◆ SetVisible()

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

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

MSDN documentation for ShadowFormat.Visible.

◆ GetAutoExcelObjectName_()

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

Returns "ShadowFormat".

Reimplemented from wxAutoExcel::wxExcelObject.