|
wxAutoExcel 2.5.1
|
Represents Microsoft Excel ThreeDFormat object. More...
#include <wxAutoExcelThreeDFormat.h>
Public Member Functions | |
| void | IncrementRotationHorizontal (double increment) |
| Changes the rotation of the specified shape horizontally by the specified number of degrees. | |
| void | IncrementRotationVertical (double increment) |
| Changes the rotation of the specified shape vertically by the specified number of degrees. | |
| void | IncrementRotationX (double increment) |
| Changes the rotation of the specified shape around the x-axis by the specified number of degrees. | |
| void | IncrementRotationY (double increment) |
| Changes the rotation of the specified shape around the y-axis by the specified number of degrees. | |
| void | IncrementRotationZ (double increment) |
| Changes the rotation of the specified shape around the z-axis by the specified number of degrees. | |
| void | ResetRotation () |
| Resets the extrusion rotation around the x-axis and the y-axis to 0 (zero) so that the front of the extrusion faces forward. | |
| void | SetExtrusionDirection (MsoPresetExtrusionDirection presetExtrusionDirection) |
| Sets the direction that the extrusion's sweep path takes away from the extruded shape. | |
| void | SetPresetCamera (MsoPresetCamera presetCamera) |
| Sets the camera for the specified ThreeDFormat object. | |
| void | SetThreeDFormat (MsoPresetThreeDFormat presetThreeDFormat) |
| Sets the preset extrusion format. | |
| double | GetBevelBottomDepth () |
| Returns the bottom depth when using the bevel effect on a ThreeDFormat object. | |
| void | SetBevelBottomDepth (double bevelBottomDepth) |
| Sets the bottom depth when using the bevel effect on a ThreeDFormat object. | |
| double | GetBevelBottomInset () |
| Returns a value indicating whether the bottom insert bevel should be raised for a ThreeDFormat object. | |
| void | SetBevelBottomInset (double bevelBottomInset) |
| Sets a value indicating whether the bottom insert bevel should be raised for a ThreeDFormat object. | |
| MsoBevelType | GetBevelBottomType () |
| Returns the bottom bevel type for a ThreeDFormat object. | |
| void | SetBevelBottomType (MsoBevelType bevelBottomType) |
| Sets the bottom bevel type for a ThreeDFormat object. | |
| double | GetBevelTopDepth () |
| Returns the top depth when using the bevel effect on a ThreeDFormat object. | |
| void | SetBevelTopDepth (double bevelTopDepth) |
| Sets the top depth when using the bevel effect on a ThreeDFormat object. | |
| double | GetBevelTopInset () |
| Returns a value indicating whether the top insert bevel should be raised for a ThreeDFormat object. | |
| void | SetBevelTopInset (double bevelTopInset) |
| Sets a value indicating whether the top insert bevel should be raised for a ThreeDFormat object. | |
| MsoBevelType | GetBevelTopType () |
| Returns the top Bevel type for a ThreeDFormat object. | |
| void | SetBevelTopType (MsoBevelType bevelTopType) |
| Sets the top Bevel type for a ThreeDFormat object. | |
| wxExcelColorFormat | GetContourColor () |
| Returns the contour color for a ThreeDFormat object. | |
| double | GetContourWidth () |
| Returns the contour width for a ThreeDFormat object. | |
| void | SetContourWidth (double contourWidth) |
| Sets the contour width for a ThreeDFormat object. | |
| double | GetDepth () |
| Returns a Single value that represents the depth of the shape's extrusion. | |
| void | SetDepth (double depth) |
| Sets a Single value that represents the depth of the shape's extrusion. | |
| wxExcelColorFormat | GetExtrusionColor () |
| Returns a ColorFormat Represents the color of the shape's extrusion. | |
| MsoExtrusionColorType | GetExtrusionColorType () |
| Returns a value that indicates whether the extrusion color is based on the extruded shape’s fill (the front face of the extrusion) and automatically changes when the shape’s fill changes, or whether the extrusion color is independent of the shape’s fill. | |
| void | SetExtrusionColorType (MsoExtrusionColorType extrusionColorType) |
| Sets a value that indicates whether the extrusion color is based on the extruded shape’s fill (the front face of the extrusion) and automatically changes when the shape’s fill changes, or whether the extrusion color is independent of the shape’s fill. | |
| double | GetFieldOfView () |
| Returns the angle at which a ThreeDFormat object can be viewed. | |
| void | SetFieldOfView (double fieldOfView) |
| Sets the angle at which a ThreeDFormat object can be viewed. | |
| double | GetLightAngle () |
| Returns the angel of the extrusion lights set on a ThreeDFormat object. | |
| void | SetLightAngle (double lightAngle) |
| Sets the angel of the extrusion lights set on a ThreeDFormat object. | |
| MsoTriState | GetPerspective () |
| Returns an MsoTriState value that determines whether the extrusion appears in perspective. | |
| void | SetPerspective (MsoTriState perspective) |
| Sets an MsoTriState value that determines whether the extrusion appears in perspective. | |
| MsoPresetCamera | GetPresetCamera () |
| Returns the extrusion preset camera for a ThreeDFormat object. | |
| MsoPresetExtrusionDirection | GetPresetExtrusionDirection () |
| Returns the direction that the extrusion's sweep path takes away from the extruded shape (the front face of the extrusion). | |
| MsoLightRigType | GetPresetLighting () |
| Returns the extrusion preset lighting for a ThreeDFormat object. | |
| void | SetPresetLighting (MsoLightRigType presetLighting) |
| Sets the extrusion preset lighting for a ThreeDFormat object. | |
| MsoPresetLightingDirection | GetPresetLightingDirection () |
| Returns the position of the light source relative to the extrusion. | |
| void | SetPresetLightingDirection (MsoPresetLightingDirection presetLightingDirection) |
| Sets the position of the light source relative to the extrusion. | |
| MsoPresetLightingSoftness | GetPresetLightingSoftness () |
| Returns the intensity of the extrusion lighting. | |
| void | SetPresetLightingSoftness (MsoPresetLightingSoftness presetLightingSoftness) |
| Sets the intensity of the extrusion lighting. | |
| MsoPresetMaterial | GetPresetMaterial () |
| Returns the extrusion surface material. | |
| void | SetPresetMaterial (MsoPresetMaterial presetMaterial) |
| Sets the extrusion surface material. | |
| MsoPresetThreeDFormat | GetPresetThreeDFormat () |
| Returns the preset extrusion format. | |
| MsoTriState | GetProjectText () |
| Returns the project text state for the specified ThreeDFormat object. | |
| void | SetProjectText (MsoTriState projectText) |
| Sets the project text state for the specified ThreeDFormat object. | |
| double | GetRotationX () |
| Returns the rotation of the extruded shape around the x-axis in degrees. | |
| void | SetRotationX (double rotationX) |
| Sets the rotation of the extruded shape around the x-axis in degrees. | |
| double | GetRotationY () |
| Returns the rotation of the extruded shape around the y-axis in degrees. | |
| void | SetRotationY (double rotationY) |
| Sets the rotation of the extruded shape around the y-axis in degrees. | |
| double | GetRotationZ () |
| Returns the rotation of the extruded shape around the z-axis in degrees. | |
| void | SetRotationZ (double rotationZ) |
| Sets the rotation of the extruded shape around the z-axis in degrees. | |
| 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 | GetZ () |
| Returns the Z order of the specified ThreeDFormat object. | |
| void | SetZ (double z) |
| Returns the Z order of the specified ThreeDFormat object. | |
| virtual wxString | GetAutoExcelObjectName_ () const |
| Returns "ThreeDFormat". | |
| 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. | |
| bool | IsLastResultNull_ () const |
| Returns true if MS Excel returned Null (or Empty) for the last property or method, e.g. | |
| 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. | |
Represents Microsoft Excel ThreeDFormat object.
| void wxAutoExcel::wxExcelThreeDFormat::IncrementRotationHorizontal | ( | double | increment | ) |
Changes the rotation of the specified shape horizontally by the specified number of degrees.
MSDN documentation for ThreeDFormat.IncrementRotationHorizontal.
| void wxAutoExcel::wxExcelThreeDFormat::IncrementRotationVertical | ( | double | increment | ) |
Changes the rotation of the specified shape vertically by the specified number of degrees.
MSDN documentation for ThreeDFormat.IncrementRotationVertical.
| void wxAutoExcel::wxExcelThreeDFormat::IncrementRotationX | ( | double | increment | ) |
Changes the rotation of the specified shape around the x-axis by the specified number of degrees.
Use the RotationX property to set the absolute rotation of the shape around the x-axis.
| void wxAutoExcel::wxExcelThreeDFormat::IncrementRotationY | ( | double | increment | ) |
Changes the rotation of the specified shape around the y-axis by the specified number of degrees.
Use the RotationY property to set the absolute rotation of the shape around the y-axis.
| void wxAutoExcel::wxExcelThreeDFormat::IncrementRotationZ | ( | double | increment | ) |
Changes the rotation of the specified shape around the z-axis by the specified number of degrees.
| void wxAutoExcel::wxExcelThreeDFormat::ResetRotation | ( | ) |
Resets the extrusion rotation around the x-axis and the y-axis to 0 (zero) so that the front of the extrusion faces forward.
This method doesn’t reset the rotation around the z-axis.
| void wxAutoExcel::wxExcelThreeDFormat::SetExtrusionDirection | ( | MsoPresetExtrusionDirection | presetExtrusionDirection | ) |
Sets the direction that the extrusion's sweep path takes away from the extruded shape.
| void wxAutoExcel::wxExcelThreeDFormat::SetPresetCamera | ( | MsoPresetCamera | presetCamera | ) |
Sets the camera for the specified ThreeDFormat object.
| void wxAutoExcel::wxExcelThreeDFormat::SetThreeDFormat | ( | MsoPresetThreeDFormat | presetThreeDFormat | ) |
Sets the preset extrusion format.
Each preset extrusion format contains a set of preset values for the various properties of the extrusion.
| double wxAutoExcel::wxExcelThreeDFormat::GetBevelBottomDepth | ( | ) |
Returns the bottom depth when using the bevel effect on a ThreeDFormat object.
Read/write Single. Since Excel 2007.
| void wxAutoExcel::wxExcelThreeDFormat::SetBevelBottomDepth | ( | double | bevelBottomDepth | ) |
Sets the bottom depth when using the bevel effect on a ThreeDFormat object.
Read/write Single.
| double wxAutoExcel::wxExcelThreeDFormat::GetBevelBottomInset | ( | ) |
Returns a value indicating whether the bottom insert bevel should be raised for a ThreeDFormat object.
Read/write Single. Since Excel 2007.
| void wxAutoExcel::wxExcelThreeDFormat::SetBevelBottomInset | ( | double | bevelBottomInset | ) |
Sets a value indicating whether the bottom insert bevel should be raised for a ThreeDFormat object.
Read/write Single.
| MsoBevelType wxAutoExcel::wxExcelThreeDFormat::GetBevelBottomType | ( | ) |
Returns the bottom bevel type for a ThreeDFormat object.
Read/write MsoBevelType. Since Excel 2007.
| void wxAutoExcel::wxExcelThreeDFormat::SetBevelBottomType | ( | MsoBevelType | bevelBottomType | ) |
Sets the bottom bevel type for a ThreeDFormat object.
Read/write MsoBevelType.
| double wxAutoExcel::wxExcelThreeDFormat::GetBevelTopDepth | ( | ) |
Returns the top depth when using the bevel effect on a ThreeDFormat object.
Read/write Single. Since Excel 2007.
| void wxAutoExcel::wxExcelThreeDFormat::SetBevelTopDepth | ( | double | bevelTopDepth | ) |
Sets the top depth when using the bevel effect on a ThreeDFormat object.
Read/write Single.
| double wxAutoExcel::wxExcelThreeDFormat::GetBevelTopInset | ( | ) |
Returns a value indicating whether the top insert bevel should be raised for a ThreeDFormat object.
Read/write Single. Since Excel 2007.
| void wxAutoExcel::wxExcelThreeDFormat::SetBevelTopInset | ( | double | bevelTopInset | ) |
Sets a value indicating whether the top insert bevel should be raised for a ThreeDFormat object.
Read/write Single.
| MsoBevelType wxAutoExcel::wxExcelThreeDFormat::GetBevelTopType | ( | ) |
Returns the top Bevel type for a ThreeDFormat object.
Read/write MsoBevelType. Since Excel 2007.
| void wxAutoExcel::wxExcelThreeDFormat::SetBevelTopType | ( | MsoBevelType | bevelTopType | ) |
Sets the top Bevel type for a ThreeDFormat object.
Read/write MsoBevelType.
| wxExcelColorFormat wxAutoExcel::wxExcelThreeDFormat::GetContourColor | ( | ) |
Returns the contour color for a ThreeDFormat object.
Read-only ColorFormat. Since Excel 2007.
| double wxAutoExcel::wxExcelThreeDFormat::GetContourWidth | ( | ) |
Returns the contour width for a ThreeDFormat object.
Read/write Single. Since Excel 2007.
| void wxAutoExcel::wxExcelThreeDFormat::SetContourWidth | ( | double | contourWidth | ) |
Sets the contour width for a ThreeDFormat object.
Read/write Single.
| double wxAutoExcel::wxExcelThreeDFormat::GetDepth | ( | ) |
Returns a Single value that represents the depth of the shape's extrusion.
| void wxAutoExcel::wxExcelThreeDFormat::SetDepth | ( | double | depth | ) |
Sets a Single value that represents the depth of the shape's extrusion.
| wxExcelColorFormat wxAutoExcel::wxExcelThreeDFormat::GetExtrusionColor | ( | ) |
Returns a ColorFormat Represents the color of the shape's extrusion.
| MsoExtrusionColorType wxAutoExcel::wxExcelThreeDFormat::GetExtrusionColorType | ( | ) |
Returns a value that indicates whether the extrusion color is based on the extruded shape’s fill (the front face of the extrusion) and automatically changes when the shape’s fill changes, or whether the extrusion color is independent of the shape’s fill.
Read/write MsoExtrusionColorType.
| void wxAutoExcel::wxExcelThreeDFormat::SetExtrusionColorType | ( | MsoExtrusionColorType | extrusionColorType | ) |
Sets a value that indicates whether the extrusion color is based on the extruded shape’s fill (the front face of the extrusion) and automatically changes when the shape’s fill changes, or whether the extrusion color is independent of the shape’s fill.
Read/write MsoExtrusionColorType.
| double wxAutoExcel::wxExcelThreeDFormat::GetFieldOfView | ( | ) |
Returns the angle at which a ThreeDFormat object can be viewed.
Read/write Single. Since Excel 2007.
| void wxAutoExcel::wxExcelThreeDFormat::SetFieldOfView | ( | double | fieldOfView | ) |
Sets the angle at which a ThreeDFormat object can be viewed.
Read/write Single.
| double wxAutoExcel::wxExcelThreeDFormat::GetLightAngle | ( | ) |
Returns the angel of the extrusion lights set on a ThreeDFormat object.
Read/write Single. Since Excel 2007.
| void wxAutoExcel::wxExcelThreeDFormat::SetLightAngle | ( | double | lightAngle | ) |
Sets the angel of the extrusion lights set on a ThreeDFormat object.
Read/write Single.
| MsoTriState wxAutoExcel::wxExcelThreeDFormat::GetPerspective | ( | ) |
Returns an MsoTriState value that determines whether the extrusion appears in perspective.
| void wxAutoExcel::wxExcelThreeDFormat::SetPerspective | ( | MsoTriState | perspective | ) |
Sets an MsoTriState value that determines whether the extrusion appears in perspective.
| MsoPresetCamera wxAutoExcel::wxExcelThreeDFormat::GetPresetCamera | ( | ) |
Returns the extrusion preset camera for a ThreeDFormat object.
Read-only MsoPresetCamera. Since Excel 2007.
| MsoPresetExtrusionDirection wxAutoExcel::wxExcelThreeDFormat::GetPresetExtrusionDirection | ( | ) |
Returns the direction that the extrusion's sweep path takes away from the extruded shape (the front face of the extrusion).
Read-only MsoPresetExtrusionDirection.
MSDN documentation for ThreeDFormat.PresetExtrusionDirection.
| MsoLightRigType wxAutoExcel::wxExcelThreeDFormat::GetPresetLighting | ( | ) |
Returns the extrusion preset lighting for a ThreeDFormat object.
Read-only MsoLightRigType. Since Excel 2007.
| void wxAutoExcel::wxExcelThreeDFormat::SetPresetLighting | ( | MsoLightRigType | presetLighting | ) |
Sets the extrusion preset lighting for a ThreeDFormat object.
Read-only MsoLightRigType.
| MsoPresetLightingDirection wxAutoExcel::wxExcelThreeDFormat::GetPresetLightingDirection | ( | ) |
Returns the position of the light source relative to the extrusion.
Read/write MsoPresetLightingDirection.
MSDN documentation for ThreeDFormat.PresetLightingDirection.
| void wxAutoExcel::wxExcelThreeDFormat::SetPresetLightingDirection | ( | MsoPresetLightingDirection | presetLightingDirection | ) |
Sets the position of the light source relative to the extrusion.
Read/write MsoPresetLightingDirection.
MSDN documentation for ThreeDFormat.PresetLightingDirection.
| MsoPresetLightingSoftness wxAutoExcel::wxExcelThreeDFormat::GetPresetLightingSoftness | ( | ) |
Returns the intensity of the extrusion lighting.
Read/write MsoPresetLightingSoftness.
| void wxAutoExcel::wxExcelThreeDFormat::SetPresetLightingSoftness | ( | MsoPresetLightingSoftness | presetLightingSoftness | ) |
Sets the intensity of the extrusion lighting.
Read/write MsoPresetLightingSoftness.
| MsoPresetMaterial wxAutoExcel::wxExcelThreeDFormat::GetPresetMaterial | ( | ) |
Returns the extrusion surface material.
Read/write MsoPresetMaterial.
| void wxAutoExcel::wxExcelThreeDFormat::SetPresetMaterial | ( | MsoPresetMaterial | presetMaterial | ) |
Sets the extrusion surface material.
Read/write MsoPresetMaterial.
| MsoPresetThreeDFormat wxAutoExcel::wxExcelThreeDFormat::GetPresetThreeDFormat | ( | ) |
Returns the preset extrusion format.
Each preset extrusion format contains a set of preset values for the various properties of the extrusion. Read-only MsoPresetThreeDFormat.
| MsoTriState wxAutoExcel::wxExcelThreeDFormat::GetProjectText | ( | ) |
Returns the project text state for the specified ThreeDFormat object.
Read/write MsoTriState. Since Excel 2007.
| void wxAutoExcel::wxExcelThreeDFormat::SetProjectText | ( | MsoTriState | projectText | ) |
Sets the project text state for the specified ThreeDFormat object.
Read/write MsoTriState.
| double wxAutoExcel::wxExcelThreeDFormat::GetRotationX | ( | ) |
Returns the rotation of the extruded shape around the x-axis in degrees.
Can be a value from – 90 through 90. A positive value indicates upward rotation; a negative value indicates downward rotation. Read/write Single.
| void wxAutoExcel::wxExcelThreeDFormat::SetRotationX | ( | double | rotationX | ) |
Sets the rotation of the extruded shape around the x-axis in degrees.
Can be a value from – 90 through 90. A positive value indicates upward rotation; a negative value indicates downward rotation. Read/write Single.
| double wxAutoExcel::wxExcelThreeDFormat::GetRotationY | ( | ) |
Returns the rotation of the extruded shape around the y-axis in degrees.
Can be a value from – 90 through 90. A positive value indicates rotation to the left; a negative value indicates rotation to the right. Read/write Single.
| void wxAutoExcel::wxExcelThreeDFormat::SetRotationY | ( | double | rotationY | ) |
Sets the rotation of the extruded shape around the y-axis in degrees.
Can be a value from – 90 through 90. A positive value indicates rotation to the left; a negative value indicates rotation to the right. Read/write Single.
| double wxAutoExcel::wxExcelThreeDFormat::GetRotationZ | ( | ) |
Returns the rotation of the extruded shape around the z-axis in degrees.
Read/write Single. Since Excel 2007.
| void wxAutoExcel::wxExcelThreeDFormat::SetRotationZ | ( | double | rotationZ | ) |
Sets the rotation of the extruded shape around the z-axis in degrees.
Read/write Single.
| MsoTriState wxAutoExcel::wxExcelThreeDFormat::GetVisible | ( | ) |
Returns a MsoTriState value that determines whether the object is visible.
| void wxAutoExcel::wxExcelThreeDFormat::SetVisible | ( | MsoTriState | visible | ) |
Sets a MsoTriState value that determines whether the object is visible.
| double wxAutoExcel::wxExcelThreeDFormat::GetZ | ( | ) |
Returns the Z order of the specified ThreeDFormat object.
Read/write Single. Since Excel 2007.
| void wxAutoExcel::wxExcelThreeDFormat::SetZ | ( | double | z | ) |
Returns the Z order of the specified ThreeDFormat object.
Read/write Single.
|
inlinevirtual |
Returns "ThreeDFormat".
Reimplemented from wxAutoExcel::wxExcelObject.