Aspose::Words::Settings::WriteProtection class
Contents
[
Hide
]WriteProtection class
Specifies write protection settings for a document. To learn more, visit the Protect or Encrypt a Document documentation article.
class WriteProtection : public System::Object
Methods
| Method | Description |
|---|---|
| get_IsWriteProtected() | Returns true when a write protection password is set. |
| get_ReadOnlyRecommended() const | Specifies whether the document author has recommended that the document be opened as read-only. |
| GetType() const override | |
| Is(const System::TypeInfo&) const override | |
| set_ReadOnlyRecommended(bool) | Setter for Aspose::Words::Settings::WriteProtection::get_ReadOnlyRecommended. |
| SetPassword(const System::String&) | Sets the write protection password for the document. |
| static Type() | |
| ValidatePassword(const System::String&) | Returns true if the specified password is the same as the write-protection password the document was protected with. If document is not write-protected with password then returns false. |
Remarks
Write protection specifies whether the author has recommended that the document is to be opened as read-only and/or require a password to modify a document.
Write protection is different from document protection. Write protection is specified in Microsoft Word in the options of the Save As dialog box.
You do not create instances of this class directly. You access document protection settings via the WriteProtection property.
Examples
Shows how to protect a document with a password.
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
builder->Writeln(u"Hello world! This document is protected.");
// Enter a password up to 15 characters in length, and then verify the document's protection status.
doc->get_WriteProtection()->SetPassword(u"MyPassword");
doc->get_WriteProtection()->set_ReadOnlyRecommended(true);
ASSERT_TRUE(doc->get_WriteProtection()->get_IsWriteProtected());
ASSERT_TRUE(doc->get_WriteProtection()->ValidatePassword(u"MyPassword"));
// Protection does not prevent the document from being edited programmatically, nor does it encrypt the contents.
doc->Save(ArtifactsDir + u"Document.WriteProtection.docx");
doc = MakeObject<Document>(ArtifactsDir + u"Document.WriteProtection.docx");
ASSERT_TRUE(doc->get_WriteProtection()->get_IsWriteProtected());
builder = MakeObject<DocumentBuilder>(doc);
builder->MoveToDocumentEnd();
builder->Writeln(u"Writing text in a protected document.");
ASSERT_EQ(String(u"Hello world! This document is protected.") + u"\rWriting text in a protected document.", doc->GetText().Trim());
See Also
- Namespace Aspose::Words::Settings
- Library Aspose.Words for C++