Contains data returned by FileFormatUtil document format detection methods.

You do not create instances of this class directly. Objects of this class are returned by DetectFileFormat() methods.

Examples

Shows how to use the FileFormatUtil class to detect the document format and encryption.

auto doc = MakeObject<Document>();
 
// Configure a SaveOptions object to encrypt the document
// with a password when we save it, and then save the document.
auto saveOptions = MakeObject<OdtSaveOptions>(SaveFormat::Odt);
saveOptions->set_Password(u"MyPassword");
 
doc->Save(ArtifactsDir + u"File.DetectDocumentEncryption.odt", saveOptions);
 
// Verify the file type of our document, and its encryption status.
SharedPtr<FileFormatInfo> info = FileFormatUtil::DetectFileFormat(ArtifactsDir + u"File.DetectDocumentEncryption.odt");
 
ASSERT_EQ(u".odt", FileFormatUtil::LoadFormatToExtension(info->get_LoadFormat()));
ASSERT_TRUE(info->get_IsEncrypted());

Shows how to use the FileFormatUtil class to detect the document format and presence of digital signatures.

// Use a FileFormatInfo instance to verify that a document is not digitally signed.
SharedPtr<FileFormatInfo> info = FileFormatUtil::DetectFileFormat(MyDir + u"Document.docx");
 
ASSERT_EQ(u".docx", FileFormatUtil::LoadFormatToExtension(info->get_LoadFormat()));
ASSERT_FALSE(info->get_HasDigitalSignature());
 
SharedPtr<CertificateHolder> certificateHolder = CertificateHolder::Create(MyDir + u"morzal.pfx", u"aw", nullptr);
auto signOptions = MakeObject<SignOptions>();
signOptions->set_SignTime(System::DateTime::get_Now());
DigitalSignatureUtil::Sign(MyDir + u"Document.docx", ArtifactsDir + u"File.DetectDigitalSignatures.docx", certificateHolder, signOptions);
 
// Use a new FileFormatInstance to confirm that it is signed.
info = FileFormatUtil::DetectFileFormat(ArtifactsDir + u"File.DetectDigitalSignatures.docx");
 
ASSERT_TRUE(info->get_HasDigitalSignature());
 
// We can load and access the signatures of a signed document in a collection like this.
ASSERT_EQ(1, DigitalSignatureUtil::LoadSignatures(ArtifactsDir + u"File.DetectDigitalSignatures.docx")->get_Count());

#include <Aspose.Words.Cpp/FileFormatInfo.h>

Inheritance diagram for Aspose::Words::FileFormatInfo:

Public Member Functions
SharedPtr< Encoding >	get_Encoding () const
	Gets the detected encoding if applicable to the current document format. At the moment detects encoding only for HTML documents. More...

bool	get_HasDigitalSignature () const
	Returns true if this document contains a digital signature. This property merely informs that a digital signature is present on a document, but it does not specify whether the signature is valid or not. More...

bool	get_IsEncrypted () const
	Returns true if the document is encrypted and requires a password to open. More...

LoadFormat	get_LoadFormat () const
	Gets the detected document format. More...

virtual const TypeInfo &	GetType () const override

virtual bool	Is (const TypeInfo &target) const override

Static Public Member Functions
static const TypeInfo &	Type ()

Member Function Documentation

◆ get_Encoding()

System::SharedPtr<System::Text::Encoding> Aspose::Words::FileFormatInfo::get_Encoding ( ) const

Gets the detected encoding if applicable to the current document format. At the moment detects encoding only for HTML documents.

Examples

Shows how to detect encoding in an html file.

SharedPtr<FileFormatInfo> info = FileFormatUtil::DetectFileFormat(MyDir + u"Document.html");
 
ASSERT_EQ(LoadFormat::Html, info->get_LoadFormat());
 
// The Encoding property is used only when we create a FileFormatInfo object for an html document.
ASSERT_EQ(u"Windows-1252", info->get_Encoding()->get_WebName());
ASSERT_EQ(1252, info->get_Encoding()->get_CodePage());

◆ get_HasDigitalSignature()

bool Aspose::Words::FileFormatInfo::get_HasDigitalSignature ( ) const

Returns true if this document contains a digital signature. This property merely informs that a digital signature is present on a document, but it does not specify whether the signature is valid or not.

This property exists to help you sort documents that are digitally signed from those that are not. If you use Aspose.Words to modify and save a document that is digitally signed, then the digital signature will be lost. This is by design because a digital signature exists to guard the authenticity of a document. Using this property you can detect digitally signed documents before processing them in the same way as normal documents and take some action to avoid losing the digital signature, for example notify the user.

Examples

Shows how to use the FileFormatUtil class to detect the document format and presence of digital signatures.

// Use a FileFormatInfo instance to verify that a document is not digitally signed.
SharedPtr<FileFormatInfo> info = FileFormatUtil::DetectFileFormat(MyDir + u"Document.docx");
 
ASSERT_EQ(u".docx", FileFormatUtil::LoadFormatToExtension(info->get_LoadFormat()));
ASSERT_FALSE(info->get_HasDigitalSignature());
 
SharedPtr<CertificateHolder> certificateHolder = CertificateHolder::Create(MyDir + u"morzal.pfx", u"aw", nullptr);
auto signOptions = MakeObject<SignOptions>();
signOptions->set_SignTime(System::DateTime::get_Now());
DigitalSignatureUtil::Sign(MyDir + u"Document.docx", ArtifactsDir + u"File.DetectDigitalSignatures.docx", certificateHolder, signOptions);
 
// Use a new FileFormatInstance to confirm that it is signed.
info = FileFormatUtil::DetectFileFormat(ArtifactsDir + u"File.DetectDigitalSignatures.docx");
 
ASSERT_TRUE(info->get_HasDigitalSignature());
 
// We can load and access the signatures of a signed document in a collection like this.
ASSERT_EQ(1, DigitalSignatureUtil::LoadSignatures(ArtifactsDir + u"File.DetectDigitalSignatures.docx")->get_Count());

◆ get_IsEncrypted()

bool Aspose::Words::FileFormatInfo::get_IsEncrypted ( ) const

Returns true if the document is encrypted and requires a password to open.

This property exists to help you sort documents that are encrypted from those that are not. If you attempt to load an encrypted document using Aspose.Words without supplying a password an exception will be thrown. You can use this property to detect whether a document requires a password and take some action before loading a document, for example, prompt the user for a password.

See also: Aspose::Words::FileFormatInfo::get_LoadFormat

Examples

Shows how to use the FileFormatUtil class to detect the document format and encryption.

auto doc = MakeObject<Document>();
 
// Configure a SaveOptions object to encrypt the document
// with a password when we save it, and then save the document.
auto saveOptions = MakeObject<OdtSaveOptions>(SaveFormat::Odt);
saveOptions->set_Password(u"MyPassword");
 
doc->Save(ArtifactsDir + u"File.DetectDocumentEncryption.odt", saveOptions);
 
// Verify the file type of our document, and its encryption status.
SharedPtr<FileFormatInfo> info = FileFormatUtil::DetectFileFormat(ArtifactsDir + u"File.DetectDocumentEncryption.odt");
 
ASSERT_EQ(u".odt", FileFormatUtil::LoadFormatToExtension(info->get_LoadFormat()));
ASSERT_TRUE(info->get_IsEncrypted());

◆ get_LoadFormat()

Aspose::Words::LoadFormat Aspose::Words::FileFormatInfo::get_LoadFormat ( ) const

Gets the detected document format.

When an OOXML document is encrypted, it is not possible to ascertained whether it is an Excel, Word or PowerPoint document without decrypting it first so for an encrypted OOXML document this property will always return Docx.

See also: Aspose::Words::FileFormatInfo::get_IsEncrypted

Examples

Shows how to use the FileFormatUtil class to detect the document format and encryption.

auto doc = MakeObject<Document>();
 
// Configure a SaveOptions object to encrypt the document
// with a password when we save it, and then save the document.
auto saveOptions = MakeObject<OdtSaveOptions>(SaveFormat::Odt);
saveOptions->set_Password(u"MyPassword");
 
doc->Save(ArtifactsDir + u"File.DetectDocumentEncryption.odt", saveOptions);
 
// Verify the file type of our document, and its encryption status.
SharedPtr<FileFormatInfo> info = FileFormatUtil::DetectFileFormat(ArtifactsDir + u"File.DetectDocumentEncryption.odt");
 
ASSERT_EQ(u".odt", FileFormatUtil::LoadFormatToExtension(info->get_LoadFormat()));
ASSERT_TRUE(info->get_IsEncrypted());

Shows how to use the FileFormatUtil class to detect the document format and presence of digital signatures.

// Use a FileFormatInfo instance to verify that a document is not digitally signed.
SharedPtr<FileFormatInfo> info = FileFormatUtil::DetectFileFormat(MyDir + u"Document.docx");
 
ASSERT_EQ(u".docx", FileFormatUtil::LoadFormatToExtension(info->get_LoadFormat()));
ASSERT_FALSE(info->get_HasDigitalSignature());
 
SharedPtr<CertificateHolder> certificateHolder = CertificateHolder::Create(MyDir + u"morzal.pfx", u"aw", nullptr);
auto signOptions = MakeObject<SignOptions>();
signOptions->set_SignTime(System::DateTime::get_Now());
DigitalSignatureUtil::Sign(MyDir + u"Document.docx", ArtifactsDir + u"File.DetectDigitalSignatures.docx", certificateHolder, signOptions);
 
// Use a new FileFormatInstance to confirm that it is signed.
info = FileFormatUtil::DetectFileFormat(ArtifactsDir + u"File.DetectDigitalSignatures.docx");
 
ASSERT_TRUE(info->get_HasDigitalSignature());
 
// We can load and access the signatures of a signed document in a collection like this.
ASSERT_EQ(1, DigitalSignatureUtil::LoadSignatures(ArtifactsDir + u"File.DetectDigitalSignatures.docx")->get_Count());

Shows how to use the FileFormatUtil methods to detect the format of a document.

// Load a document from a file that is missing a file extension, and then detect its file format.
{
    SharedPtr<System::IO::FileStream> docStream = System::IO::File::OpenRead(MyDir + u"Word document with missing file extension");
    SharedPtr<FileFormatInfo> info = FileFormatUtil::DetectFileFormat(docStream);
    LoadFormat loadFormat = info->get_LoadFormat();
 
    ASSERT_EQ(LoadFormat::Doc, loadFormat);
 
    // Below are two methods of converting a LoadFormat to its corresponding SaveFormat.
    // 1 -  Get the file extension string for the LoadFormat, then get the corresponding SaveFormat from that string:
    String fileExtension = FileFormatUtil::LoadFormatToExtension(loadFormat);
    SaveFormat saveFormat = FileFormatUtil::ExtensionToSaveFormat(fileExtension);
 
    // 2 -  Convert the LoadFormat directly to its SaveFormat:
    saveFormat = FileFormatUtil::LoadFormatToSaveFormat(loadFormat);
 
    // Load a document from the stream, and then save it to the automatically detected file extension.
    auto doc = MakeObject<Document>(docStream);
 
    ASSERT_EQ(u".doc", FileFormatUtil::SaveFormatToExtension(saveFormat));
 
    doc->Save(ArtifactsDir + u"File.SaveToDetectedFileFormat" + FileFormatUtil::SaveFormatToExtension(saveFormat));
}

◆ GetType()

virtual const System::TypeInfo& Aspose::Words::FileFormatInfo::GetType ( ) const

overridevirtual

Reimplemented from System::Object.

◆ Is()

virtual bool Aspose::Words::FileFormatInfo::Is ( const System::TypeInfo & target ) const

overridevirtual

Reimplemented from System::Object.

◆ Type()

static const System::TypeInfo& Aspose::Words::FileFormatInfo::Type ( )

static

Public Member Functions

Static Public Member Functions

Member Function Documentation

◆ get_Encoding()

◆ get_HasDigitalSignature()

◆ get_IsEncrypted()

◆ get_LoadFormat()

◆ GetType()

◆ Is()

◆ Type()