Class DocumentProtectionSettings

Class describing the protection settings which can be applied on a RadDocument.

Inheritance
System.Object
DocumentProtectionSettings
Namespace: Telerik.Windows.Documents.Model
Assembly: Telerik.Windows.Documents.dll

Syntax

public class DocumentProtectionSettings : Object, INotifyPropertyChanged

Constructors

DocumentProtectionSettings()

Initializes a new instance of the DocumentProtectionSettings class.

Declaration
public DocumentProtectionSettings()

DocumentProtectionSettings(DocumentProtectionSettings)

Initializes a new instance of the DocumentProtectionSettings class by copying the settings from another instance.

Declaration
public DocumentProtectionSettings(DocumentProtectionSettings source)
Parameters
DocumentProtectionSettings source

The source.

Properties

EnableDocumentProtection

Gets or sets a value indicating whether the document protection is enabled.

Declaration
[XamlSerializable]
public bool EnableDocumentProtection { get; set; }
Property Value
System.Boolean

true if document protection is enabled; otherwise, false.

Enforce

Gets or sets a value indicating whether this DocumentProtectionSettings are enforced.

Declaration
[XamlSerializable]
public bool Enforce { get; set; }
Property Value
System.Boolean

true if the settings are enforced; otherwise, false.

HashingAlgorithm

Gets or sets the hashing algorithm. The supported for document protection values are MD5 and SHA1.

Declaration
[XamlSerializable]
public HashingAlgorithm HashingAlgorithm { get; set; }
Property Value
HashingAlgorithm

The hashing algorithm.

HashingSpinCount

Gets or sets the count of hashing spins which should be used when protecting.

Declaration
[XamlSerializable]
public int HashingSpinCount { get; set; }
Property Value
System.Int32

The hashing spin count.

HasPassword

Gets a value indicating whether this instance has password.

Declaration
public bool HasPassword { get; }
Property Value
System.Boolean

true if this instance has password; otherwise, false.

IsHashingAlgorithmSupported

Gets a value indicating whether the HashingAlgorithm applied to this instance is supported.

Declaration
public bool IsHashingAlgorithmSupported { get; }
Property Value
System.Boolean

true if this instance is hashing algorithm supported; otherwise, false.

PasswordHash

Gets or sets the password hash.

Declaration
[XamlSerializable]
public string PasswordHash { get; set; }
Property Value
System.String

The password hash.

ProtectionMode

Gets or sets the protection mode.

Declaration
[XamlSerializable]
public DocumentProtectionMode ProtectionMode { get; set; }
Property Value
DocumentProtectionMode

The protection mode.

Salt

Gets or sets the salt.

Declaration
[XamlSerializable]
public string Salt { get; set; }
Property Value
System.String

The salt.

Methods

Equals(Object)

Determines whether the specified System.Object, is equal to this instance.

Declaration
public override bool Equals(object obj)
Parameters
System.Object obj

The System.Object to compare with this instance.
Returns
System.Boolean

true if the specified System.Object is equal to this instance; otherwise, false.

GetHashCode()

Returns a hash code for this instance.

Declaration
public override int GetHashCode()
Returns
System.Int32

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

Events

PropertyChanged

Occurs when a property value changes.

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
System.ComponentModel.PropertyChangedEventHandler

Operators

Equality(DocumentProtectionSettings, DocumentProtectionSettings)

Implements the operator ==.

Declaration
public static bool operator ==(DocumentProtectionSettings first, DocumentProtectionSettings second)
Parameters
DocumentProtectionSettings first

The first.
DocumentProtectionSettings second

The second.
Returns
System.Boolean

The result of the operator.

Inequality(DocumentProtectionSettings, DocumentProtectionSettings)

Implements the operator !=.

Declaration
public static bool operator !=(DocumentProtectionSettings first, DocumentProtectionSettings second)
Parameters
DocumentProtectionSettings first

The first.
DocumentProtectionSettings second

The second.
Returns
System.Boolean

The result of the operator.

Extension Methods

See Also

System.ComponentModel.INotifyPropertyChanged