Method Freeze

Freeze(DocumentId)

Freezes a document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 12, 0, 0)]
void Freeze(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.

Remarks

An exception will be thrown when trying to freeze a document that is not freezable.

StartModification(string, bool) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.12.