OfficeEncryptor Component

Properties   Methods   Events   Config Settings   Errors  

The OfficeEncryptor component encrypts Office documents.

Syntax

TsbxOfficeEncryptor

Remarks

OfficeEncryptor encrypts Office documents.

Property List

---

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

DocumentFormat Property (OfficeEncryptor Component)

Defines the format of the Office document.

Syntax

__property TsbxOfficeEncryptorDocumentFormats DocumentFormat = { read=FDocumentFormat };

enum TsbxOfficeEncryptorDocumentFormats {
  odfUnknown=0,
  odfBinary=1,
  odfOpenXML=2,
  odfOpenXPS=3,
  odfOpenDocument=4
};

Default Value

odfUnknown

Remarks

This property contains the Office document format.

This property is read-only and not available at design time.

Data Type

Integer

DocumentType Property (OfficeEncryptor Component)

Defines the type of the Office document.

Syntax

__property String DocumentType = { read=FDocumentType };

Default Value

""

Remarks

This property contains the Office document type.

This property is read-only and not available at design time.

Data Type

String

EncryptionAlgorithm Property (OfficeEncryptor Component)

The encryption algorithm used to encrypt the document.

Syntax

__property String EncryptionAlgorithm = { read=FEncryptionAlgorithm, write=FSetEncryptionAlgorithm };

Default Value

"Default"

Remarks

This property contains the encryption algorithm used to encrypt the Office document.

Supported values:

For Binary Office documents

For OpenXML Office documents (default = SB_SYMMETRIC_ALGORITHM_AES256)

For OpenOffice documents (default = SB_SYMMETRIC_ALGORITHM_BLOWFISH)

Data Type

String

EncryptionType Property (OfficeEncryptor Component)

The encryption type used to encrypt the document.

Syntax

__property TsbxOfficeEncryptorEncryptionTypes EncryptionType = { read=FEncryptionType, write=FSetEncryptionType };

enum TsbxOfficeEncryptorEncryptionTypes {
  oetDefault=0,
  oetBinaryRC4=1,
  oetBinaryRC4CryptoAPI=2,
  oetOpenXMLStandard=3,
  oetOpenXMLAgile=4,
  oetOpenDocument=5
};

Default Value

oetDefault

Remarks

This property contains the encryption type used to encrypt the Office document.

Supported values:

oetDefault uses default encryption depending on Office document format.

oetBinaryRC4 uses RC4 encryption for Binary Office documents.

oetBinaryRC4CryptoAPI uses RC4 Crypto API encryption for Binary Office documents.

oetOpenXMLStandard uses standard encryption for OpenXML Office documents.

oetOpenXMLAgile uses agile encryption for OpenXML Office documents.

oetOpenDocument uses standard encryption for OpenOffice documents.

Data Type

Integer

FIPSMode Property (OfficeEncryptor Component)

Reserved.

Syntax

__property bool FIPSMode = { read=FFIPSMode, write=FSetFIPSMode };

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

InputBytes Property (OfficeEncryptor Component)

Use this property to pass the input to component in byte array form.

Syntax

__property DynamicArray InputBytes = { read=FInputBytes, write=FSetInputBytes };

Remarks

Assign a byte array containing the data to be processed to this property.

This property is not available at design time.

Data Type

Byte Array

InputFile Property (OfficeEncryptor Component)

The Office file to be encrypted.

Syntax

__property String InputFile = { read=FInputFile, write=FSetInputFile };

Default Value

""

Remarks

Provide the path to the Office document to be encrypted.

Data Type

String

OutputBytes Property (OfficeEncryptor Component)

Use this property to read the output the component object has produced.

Syntax

__property DynamicArray OutputBytes = { read=FOutputBytes };

Remarks

Read the contents of this property after the operation has completed to read the produced output. This property will only be set if the OutputFile and OutputStream properties had not been assigned.

This property is read-only and not available at design time.

Data Type

Byte Array

OutputFile Property (OfficeEncryptor Component)

Defines where to save the encrypted document.

Syntax

__property String OutputFile = { read=FOutputFile, write=FSetOutputFile };

Default Value

""

Remarks

Specifies the path where the encrypted Office document should be saved.

Data Type

String

Password Property (OfficeEncryptor Component)

The password used for decryption.

Syntax

__property String Password = { read=FPassword, write=FSetPassword };

Default Value

""

Remarks

Use this property to provide the decryption password.

Data Type

String

Config Method (OfficeEncryptor Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DoAction Method (OfficeEncryptor Component)

Performs an additional action.

Syntax

String __fastcall DoAction(String ActionID, String ActionParams);

Remarks

DoAction is a generic method available in every component. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Encrypt Method (OfficeEncryptor Component)

Encrypts the whole document.

Syntax

void __fastcall Encrypt();

Remarks

Call this method to encrypt the document.

Error Event (OfficeEncryptor Component)

Information about errors during signing.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TsbxOfficeEncryptorErrorEventParams;
typedef void __fastcall (__closure *TsbxOfficeEncryptorErrorEvent)(System::TObject* Sender, TsbxOfficeEncryptorErrorEventParams *e);
__property TsbxOfficeEncryptorErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

This event is fired in case of exceptional conditions during the office document processing.

ErrorCode contains an error code and Description contains a textual description of the error.

Notification Event (OfficeEncryptor Component)

This event notifies the application about an underlying control flow event.

Syntax

typedef struct {
  String EventID;
  String EventParam;
} TsbxOfficeEncryptorNotificationEventParams;
typedef void __fastcall (__closure *TsbxOfficeEncryptorNotificationEvent)(System::TObject* Sender, TsbxOfficeEncryptorNotificationEventParams *e);
__property TsbxOfficeEncryptorNotificationEvent OnNotification = { read=FOnNotification, write=FOnNotification };

Remarks

The component fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.

This component can fire this event with the following EventID values:

Config Settings (OfficeEncryptor Component)

The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

OfficeEncryptor Config Settings

Base Config Settings

Trappable Errors (OfficeEncryptor Component)

OfficeEncryptor Errors

	1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
	1048578   Component is configured incorrectly (SB_ERROR_INVALID_SETUP)
	1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
	1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
	1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
	1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) 
	24117249   Input file does not exist (SB_ERROR_OFFICE_INPUTFILE_NOT_EXISTS)
	24117250   Unsupported document format (SB_ERROR_OFFICE_UNSUPPORTED_DOCUMENT_FORMAT)
	24117251   Document cannot be signed (SB_ERROR_OFFICE_DOCUMENT_NOT_SIGNABLE)
	24117252   Document is not signed (SB_ERROR_OFFICE_DOCUMENT_NOT_SIGNED)
	24117253   Document is encrypted (SB_ERROR_OFFICE_DOCUMENT_ENCRYPTED)
	24117254   Document cannot be encrypted (SB_ERROR_OFFICE_DOCUMENT_NOT_ENCRYPTABLE)
	24117255   Document is not encrypted (SB_ERROR_OFFICE_DOCUMENT_NOT_ENCRYPTED)
	24117256   Unknown encryption algorithm (SB_ERROR_OFFICE_DOCUMENT_UNKNOWN_ENCRYPTION)
	24117257   Invalid password (SB_ERROR_OFFICE_INVALID_PASSWORD)
	24117258   Signature not found (SB_ERROR_OFFICE_SIGNATURE_NOT_FOUND)