wxAutoExcel  2.0.0
wxAutoExcel::wxExcelProtection Class Reference

Represents the various types of protection options available for a worksheet. More...

Inheritance diagram for wxAutoExcel::wxExcelProtection:
wxAutoExcel::wxExcelObject

Public Member Functions

bool GetAllowDeletingColumns ()
 Returns True if the deletion of columns is allowed on a protected worksheet. More...
 
bool GetAllowDeletingRows ()
 Returns True if the deletion of rows is allowed on a protected worksheet. More...
 
wxExcelAllowEditRanges GetAllowEditRanges ()
 Returns an AllowEditRanges object. More...
 
bool GetAllowFiltering ()
 Returns True if the user is allowed to make use of an AutoFilter that was created before the sheet was protected. More...
 
bool GetAllowFormattingCells ()
 Returns True if the formatting of cells is allowed on a protected worksheet. More...
 
bool GetAllowFormattingColumns ()
 Returns True if the formatting of columns is allowed on a protected worksheet. More...
 
bool GetAllowFormattingRows ()
 Returns True if the formatting of rows is allowed on a protected worksheet. More...
 
bool GetAllowInsertingColumns ()
 Returns True if the insertion of columns is allowed on a protected worksheet. More...
 
bool GetAllowInsertingHyperlinks ()
 Returns True if the insertion of hyperlinks is allowed on a protected worksheet. More...
 
bool GetAllowInsertingRows ()
 Returns True if the insertion of rows is allowed on a protected worksheet. More...
 
bool GetAllowSorting ()
 Returns True if the sorting option is allowed on a protected worksheet. More...
 
bool GetAllowUsingPivotTables ()
 Returns True if the user is allowed to manipulate pivot tables on a protected worksheet. More...
 
virtual wxString GetAutoExcelObjectName_ () const
 Returns "Protection". 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 various types of protection options available for a worksheet.

Member Function Documentation

◆ GetAllowDeletingColumns()

bool wxAutoExcel::wxExcelProtection::GetAllowDeletingColumns ( )

Returns True if the deletion of columns is allowed on a protected worksheet.

Excel VBA documentation for Protection.AllowDeletingColumns

◆ GetAllowDeletingRows()

bool wxAutoExcel::wxExcelProtection::GetAllowDeletingRows ( )

Returns True if the deletion of rows is allowed on a protected worksheet.

Excel VBA documentation for Protection.AllowDeletingRows

◆ GetAllowEditRanges()

wxExcelAllowEditRanges wxAutoExcel::wxExcelProtection::GetAllowEditRanges ( )

Returns an AllowEditRanges object.

Excel VBA documentation for Protection.AllowEditRanges

◆ GetAllowFiltering()

bool wxAutoExcel::wxExcelProtection::GetAllowFiltering ( )

Returns True if the user is allowed to make use of an AutoFilter that was created before the sheet was protected.

Excel VBA documentation for Protection.AllowFiltering

◆ GetAllowFormattingCells()

bool wxAutoExcel::wxExcelProtection::GetAllowFormattingCells ( )

Returns True if the formatting of cells is allowed on a protected worksheet.

Excel VBA documentation for Protection.AllowFormattingCells

◆ GetAllowFormattingColumns()

bool wxAutoExcel::wxExcelProtection::GetAllowFormattingColumns ( )

Returns True if the formatting of columns is allowed on a protected worksheet.

Excel VBA documentation for Protection.AllowFormattingColumns

◆ GetAllowFormattingRows()

bool wxAutoExcel::wxExcelProtection::GetAllowFormattingRows ( )

Returns True if the formatting of rows is allowed on a protected worksheet.

Excel VBA documentation for Protection.AllowFormattingRows

◆ GetAllowInsertingColumns()

bool wxAutoExcel::wxExcelProtection::GetAllowInsertingColumns ( )

Returns True if the insertion of columns is allowed on a protected worksheet.

Excel VBA documentation for Protection.AllowInsertingColumns

◆ GetAllowInsertingHyperlinks()

bool wxAutoExcel::wxExcelProtection::GetAllowInsertingHyperlinks ( )

Returns True if the insertion of hyperlinks is allowed on a protected worksheet.

Excel VBA documentation for Protection.AllowInsertingHyperlinks

◆ GetAllowInsertingRows()

bool wxAutoExcel::wxExcelProtection::GetAllowInsertingRows ( )

Returns True if the insertion of rows is allowed on a protected worksheet.

Excel VBA documentation for Protection.AllowInsertingRows

◆ GetAllowSorting()

bool wxAutoExcel::wxExcelProtection::GetAllowSorting ( )

Returns True if the sorting option is allowed on a protected worksheet.

Excel VBA documentation for Protection.AllowSorting

◆ GetAllowUsingPivotTables()

bool wxAutoExcel::wxExcelProtection::GetAllowUsingPivotTables ( )

Returns True if the user is allowed to manipulate pivot tables on a protected worksheet.

Excel VBA documentation for Protection.AllowUsingPivotTables

◆ GetAutoExcelObjectName_()

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

Returns "Protection".

Reimplemented from wxAutoExcel::wxExcelObject.