wxAutoExcel 2.5.1
Loading...
Searching...
No Matches
wxAutoExcel::wxExcelAllowEditRange Class Reference

Represents a collection of all the AllowEditRange objects that represent the cells that can be edited on a protected worksheet. More...

#include <wxAutoExcelAllowEditRanges.h>

Inheritance diagram for wxAutoExcel::wxExcelAllowEditRange:
wxAutoExcel::wxExcelObject

Public Member Functions

void ChangePassword (const wxString &password)
 Changes the password for a range that can be edited on a protected worksheet.
void Delete ()
 Deletes the object.
void Unprotect (const wxString &password)
 Removes protection from a sheet or workbook.
wxExcelRange GetRange ()
 Returns a Range object that represents a subset of the ranges that can be edited edited on a protected worksheet.
wxString GetTitle ()
 Returns the title of the range of cells that can edited on a protected sheet.
void SetTitle (const wxString &title)
 Sets the title of the range of cells that can edited on a protected sheet.
wxExcelUserAccessList GetUsers ()
 Returns a UserAccessList object for the protected range on a worksheet.
virtual wxString GetAutoExcelObjectName_ () const
 Returns "AllowEditRange".
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.

Detailed Description

Represents a collection of all the AllowEditRange objects that represent the cells that can be edited on a protected worksheet.

Member Function Documentation

◆ ChangePassword()

void wxAutoExcel::wxExcelAllowEditRange::ChangePassword ( const wxString & password)

Changes the password for a range that can be edited on a protected worksheet.

Excel VBA documentation for AllowEditRange.ChangePassword

◆ Delete()

void wxAutoExcel::wxExcelAllowEditRange::Delete ( )

◆ Unprotect()

void wxAutoExcel::wxExcelAllowEditRange::Unprotect ( const wxString & password)

Removes protection from a sheet or workbook.

This method has no effect if the sheet or workbook isn't protected.

Excel VBA documentation for AllowEditRange.Unprotect

◆ GetRange()

wxExcelRange wxAutoExcel::wxExcelAllowEditRange::GetRange ( )

Returns a Range object that represents a subset of the ranges that can be edited edited on a protected worksheet.

Excel VBA documentation for AllowEditRange.Range

◆ GetTitle()

wxString wxAutoExcel::wxExcelAllowEditRange::GetTitle ( )

Returns the title of the range of cells that can edited on a protected sheet.

Excel VBA documentation for AllowEditRange.Title

◆ SetTitle()

void wxAutoExcel::wxExcelAllowEditRange::SetTitle ( const wxString & title)

Sets the title of the range of cells that can edited on a protected sheet.

Excel VBA documentation for AllowEditRange.Title

◆ GetUsers()

wxExcelUserAccessList wxAutoExcel::wxExcelAllowEditRange::GetUsers ( )

Returns a UserAccessList object for the protected range on a worksheet.

Excel VBA documentation for AllowEditRange.Users

◆ GetAutoExcelObjectName_()

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

Returns "AllowEditRange".

Reimplemented from wxAutoExcel::wxExcelObject.