Skip to main content

TdxSpreadSheetWorkbookProtectionOptions Class

Stores spreadsheet document structure protection settings.

Declaration

TdxSpreadSheetWorkbookProtectionOptions = class(
    TdxSpreadSheetCustomProtectionOptions
)

Remarks

This class implements a set of end-user permissions applied to the protected spreadsheet document structure. You can use the ActualAllowChangeStructure, AllowChangeStructure, and Protected properties provided by the TdxSpreadSheetWorkbookProtectionOptions class to identify and specify if an end-user is able to create, rename, rearrange, hide, display, and delete individual sheets in a spreadsheet document.

Restricting the end-user capability to manage the spreadsheet document structure automatically disables the corresponding built-in and generated UI elements of the Spreadsheet or Report Designer control.

Note that all end-user permission settings provided by the TdxSpreadSheetWorkbookProtectionOptions class do not impose any limitations on the capability to perform the corresponding actions programmatically.

To enforce the spreadsheet document structure protection programmatically, assign a new TdxSpreadSheetStandardProtectionInfo or TdxSpreadSheetStrongProtectionInfo class instance to the ProtectionInfo property with the required password passed as the constructor ‘s APassword parameter. For detailed information on protecting the spreadsheet document structure with a password, refer to the Spreadsheet Document Structure Protection section of the Password Protection topic.

The OptionsProtection property of the Spreadsheet and Report Designer controls references a TdxSpreadSheetWorkbookProtectionOptions object.

Inheritance

TObject
TPersistent
TdxSpreadSheetCustomProtectionOptions
TdxSpreadSheetWorkbookProtectionOptions
See Also