Class representing embedded file. More...
#include "FileSpecification.h"
Inherits System::IDisposable.
Public Member Functions | |
ASPOSE_PDF_SHARED_API FileEncoding | get_Encoding () const |
Gets encoding format. Possible values: Zip - file is compressed with ZIP, None - file is not compressed. More... | |
ASPOSE_PDF_SHARED_API void | set_Encoding (FileEncoding value) |
Sets encoding format. Possible values: Zip - file is compressed with ZIP, None - file is not compressed. More... | |
ASPOSE_PDF_SHARED_API bool | get_IncludeContents () const |
If true, contents of the file will be included in the file specification. More... | |
ASPOSE_PDF_SHARED_API void | set_IncludeContents (bool value) |
If true, contents of the file will be included in the file specification. More... | |
ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::CollectionItem > | get_CollectionItem () |
Gets a collection item of the file specification. More... | |
ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::EncryptedPayload > | get_EncryptedPayload () |
Gets encrypted payload. More... | |
ASPOSE_PDF_SHARED_API System::String | get_Description () |
Gets text associated with the file specification. More... | |
ASPOSE_PDF_SHARED_API void | set_Description (System::String value) |
Sets text associated with the file specification. More... | |
ASPOSE_PDF_SHARED_API Aspose::Pdf::AFRelationship | get_AFRelationship () |
Associated file Relationship. More... | |
ASPOSE_PDF_SHARED_API void | set_AFRelationship (Aspose::Pdf::AFRelationship value) |
Associated file Relationship. More... | |
ASPOSE_PDF_SHARED_API System::SharedPtr< System::IO::Stream > | get_StreamContents () |
Gets contents of file as stream. Contents is not loaded into memory which allows to decrease memory usage. But this stream does not support positioning and Length property. If you need this features please use Contents property instead. More... | |
ASPOSE_PDF_SHARED_API System::SharedPtr< System::IO::Stream > | get_Contents () |
Gets contents file. This property returns data loaded in memory which may cause Out of memory exception for large data. To decrease memory usage please use StreamContents. More... | |
ASPOSE_PDF_SHARED_API void | set_Contents (System::SharedPtr< System::IO::Stream > value) |
Sets contents file. This property returns data loaded in memory which may cause Out of memory exception for large data. To decrease memory usage please use StreamContents. More... | |
ASPOSE_PDF_SHARED_API System::SharedPtr< FileParams > | get_Params () |
Gets file paramteres. More... | |
ASPOSE_PDF_SHARED_API void | set_Params (System::SharedPtr< FileParams > value) |
Gets file paramteres. More... | |
ASPOSE_PDF_SHARED_API System::String | get_MIMEType () |
Gets subtype of the embedded file More... | |
ASPOSE_PDF_SHARED_API void | set_MIMEType (System::String value) |
Gets subtype of the embedded file More... | |
ASPOSE_PDF_SHARED_API System::String | get_Name () |
Gets file specification name. More... | |
ASPOSE_PDF_SHARED_API void | set_Name (System::String value) |
Sets file specification name. More... | |
ASPOSE_PDF_SHARED_API System::String | get_UnicodeName () |
Gets file specification unicode name. More... | |
ASPOSE_PDF_SHARED_API void | set_UnicodeName (System::String value) |
Sets file specification unicode name. More... | |
ASPOSE_PDF_SHARED_API System::String | get_FileSystem () |
Gets name of the file system. More... | |
ASPOSE_PDF_SHARED_API void | set_FileSystem (System::String value) |
Sets name of the file system. More... | |
ASPOSE_PDF_SHARED_API | FileSpecification (System::String file) |
Constructor for FileSpecification More... | |
ASPOSE_PDF_SHARED_API | FileSpecification (System::SharedPtr< System::IO::Stream > stream, System::String name) |
Constructor for file specification. More... | |
ASPOSE_PDF_SHARED_API | FileSpecification (System::String file, System::String description) |
Constructor for FileSpecification. More... | |
ASPOSE_PDF_SHARED_API | FileSpecification (System::SharedPtr< System::IO::Stream > stream, System::String name, System::String description) |
Constructor for FileSpecification. More... | |
ASPOSE_PDF_SHARED_API | FileSpecification (System::String fileName, System::SharedPtr< Annotations::Annotation > annot) |
Constructor for FileSpecification. More... | |
ASPOSE_PDF_SHARED_API | FileSpecification () |
Create new empty file specification. More... | |
ASPOSE_PDF_SHARED_API System::String | GetValue (System::String key) |
Gets application-specific parameter. More... | |
ASPOSE_PDF_SHARED_API void | SetValue (System::String key, System::String value) |
Sets application-specific parameter. More... | |
ASPOSE_PDF_SHARED_API void | Dispose () override |
Dispose contents. More... | |
Public Member Functions inherited from System::Object | |
ASPOSECPP_SHARED_API | Object () |
Creates object. Initializes all internal data structures. More... | |
virtual ASPOSECPP_SHARED_API | ~Object () |
Destroys object. Frees all internal data structures. More... | |
ASPOSECPP_SHARED_API | Object (Object const &x) |
Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More... | |
Object & | operator= (Object const &x) |
Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More... | |
Object * | SharedRefAdded () |
Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More... | |
int | SharedRefRemovedSafe () |
Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More... | |
int | RemovedSharedRefs (int count) |
Decreases shared reference count by specified value. More... | |
Detail::SmartPtrCounter * | WeakRefAdded () |
Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More... | |
void | WeakRefRemoved () |
Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More... | |
Detail::SmartPtrCounter * | GetCounter () |
Gets reference counter data structure associated with the object. More... | |
int | SharedCount () const |
Gets current value of shared reference counter. More... | |
ASPOSECPP_SHARED_API void | Lock () |
Implements C# lock() statement locking. Call directly or use LockContext sentry object. More... | |
ASPOSECPP_SHARED_API void | Unlock () |
Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More... | |
virtual ASPOSECPP_SHARED_API bool | Equals (ptr obj) |
Compares objects using C# Object.Equals semantics. More... | |
virtual ASPOSECPP_SHARED_API int32_t | GetHashCode () const |
Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More... | |
virtual ASPOSECPP_SHARED_API String | ToString () const |
Analog of C# Object.ToString() method. Enables converting custom objects to string. More... | |
virtual ASPOSECPP_SHARED_API ptr | MemberwiseClone () const |
Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More... | |
virtual ASPOSECPP_SHARED_API const TypeInfo & | GetType () const |
Gets actual type of object. Analog of C# System.Object.GetType() call. More... | |
virtual ASPOSECPP_SHARED_API bool | Is (const TypeInfo &targetType) const |
Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More... | |
virtual ASPOSECPP_SHARED_API void | SetTemplateWeakPtr (uint32_t argument) |
Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More... | |
virtual ASPOSECPP_SHARED_API bool | FastCast (const Details::FastRttiBase &helper, void **out_ptr) const |
For internal purposes only. More... | |
template<> | |
bool | Equals (float const &objA, float const &objB) |
Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More... | |
template<> | |
bool | Equals (double const &objA, double const &objB) |
Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More... | |
template<> | |
bool | ReferenceEquals (String const &str, std::nullptr_t) |
Specialization of Object::ReferenceEquals for case of string and nullptr. More... | |
template<> | |
bool | ReferenceEquals (String const &str1, String const &str2) |
Specialization of Object::ReferenceEquals for case of strings. More... | |
Protected Member Functions | |
System::SharedPtr< Engine::Data::IPdfDictionary > | get_EngineDict () |
Pdf dictionary containing information about the file. More... | |
System::SharedPtr< Engine::Data::IPdfObject > | get_EngineObj () const |
FileSpecification (System::SharedPtr< Engine::Data::IPdfPrimitive > specification) | |
MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (FileSpecification, CODEPORTING_ARGS(System::SharedPtr< Engine::Data::IPdfPrimitive > specification)) | |
void | SendMeteredInformation () |
System::SharedPtr< Engine::Data::IPdfPrimitive > | createFileSpecification (System::SharedPtr< Engine::Data::ITrailerable > trailer) |
Creates file specification More... | |
virtual ASPOSE_PDF_SHARED_API | ~FileSpecification () |
Additional Inherited Members | |
Public Types inherited from System::Object | |
typedef SmartPtr< Object > | ptr |
Alias for smart pointer type. More... | |
Static Public Member Functions inherited from System::Object | |
static bool | ReferenceEquals (ptr const &objA, ptr const &objB) |
Compares objects by reference. More... | |
template<typename T > | |
static std::enable_if<!IsSmartPtr< T >::value, bool >::type | ReferenceEquals (T const &objA, T const &objB) |
Compares objects by reference. More... | |
template<typename T > | |
static std::enable_if<!IsSmartPtr< T >::value, bool >::type | ReferenceEquals (T const &objA, std::nullptr_t) |
Reference-compares value type object with nullptr. More... | |
template<typename T1 , typename T2 > | |
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type | Equals (T1 const &objA, T2 const &objB) |
Compares reference type objects in C# style. More... | |
template<typename T1 , typename T2 > | |
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type | Equals (T1 const &objA, T2 const &objB) |
Compares value type objects in C# style. More... | |
static const TypeInfo & | Type () |
Implements C# typeof(System.Object) construct. More... | |
Class representing embedded file.
ASPOSE_PDF_SHARED_API Aspose::Pdf::FileSpecification::FileSpecification | ( | System::String | file | ) |
Constructor for FileSpecification
file | File path. |
ASPOSE_PDF_SHARED_API Aspose::Pdf::FileSpecification::FileSpecification | ( | System::SharedPtr< System::IO::Stream > | stream, |
System::String | name | ||
) |
Constructor for file specification.
stream | Stream containing data file. |
name | File specification. |
ASPOSE_PDF_SHARED_API Aspose::Pdf::FileSpecification::FileSpecification | ( | System::String | file, |
System::String | description | ||
) |
Constructor for FileSpecification.
file | File path. |
description | File description. |
ASPOSE_PDF_SHARED_API Aspose::Pdf::FileSpecification::FileSpecification | ( | System::SharedPtr< System::IO::Stream > | stream, |
System::String | name, | ||
System::String | description | ||
) |
Constructor for FileSpecification.
stream | Stream to be used in the document. |
name | A file specification string. |
description | File description. |
ASPOSE_PDF_SHARED_API Aspose::Pdf::FileSpecification::FileSpecification | ( | System::String | fileName, |
System::SharedPtr< Annotations::Annotation > | annot | ||
) |
Constructor for FileSpecification.
fileName | File path. |
annot | The annotation. |
ASPOSE_PDF_SHARED_API Aspose::Pdf::FileSpecification::FileSpecification | ( | ) |
Create new empty file specification.
|
protected |
|
protectedvirtual |
|
protected |
Creates file specification
trailer | Trailerable object. |
|
overridevirtual |
Dispose contents.
Reimplemented from System::IDisposable.
ASPOSE_PDF_SHARED_API Aspose::Pdf::AFRelationship Aspose::Pdf::FileSpecification::get_AFRelationship | ( | ) |
Associated file Relationship.
ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::CollectionItem> Aspose::Pdf::FileSpecification::get_CollectionItem | ( | ) |
Gets a collection item of the file specification.
ASPOSE_PDF_SHARED_API System::SharedPtr<System::IO::Stream> Aspose::Pdf::FileSpecification::get_Contents | ( | ) |
Gets contents file. This property returns data loaded in memory which may cause Out of memory exception for large data. To decrease memory usage please use StreamContents.
ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::FileSpecification::get_Description | ( | ) |
Gets text associated with the file specification.
ASPOSE_PDF_SHARED_API FileEncoding Aspose::Pdf::FileSpecification::get_Encoding | ( | ) | const |
Gets encoding format. Possible values: Zip - file is compressed with ZIP, None - file is not compressed.
ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::EncryptedPayload> Aspose::Pdf::FileSpecification::get_EncryptedPayload | ( | ) |
Gets encrypted payload.
|
protected |
Pdf dictionary containing information about the file.
|
protected |
ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::FileSpecification::get_FileSystem | ( | ) |
Gets name of the file system.
ASPOSE_PDF_SHARED_API bool Aspose::Pdf::FileSpecification::get_IncludeContents | ( | ) | const |
If true, contents of the file will be included in the file specification.
ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::FileSpecification::get_MIMEType | ( | ) |
Gets subtype of the embedded file
ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::FileSpecification::get_Name | ( | ) |
Gets file specification name.
ASPOSE_PDF_SHARED_API System::SharedPtr<FileParams> Aspose::Pdf::FileSpecification::get_Params | ( | ) |
Gets file paramteres.
ASPOSE_PDF_SHARED_API System::SharedPtr<System::IO::Stream> Aspose::Pdf::FileSpecification::get_StreamContents | ( | ) |
Gets contents of file as stream. Contents is not loaded into memory which allows to decrease memory usage. But this stream does not support positioning and Length property. If you need this features please use Contents property instead.
ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::FileSpecification::get_UnicodeName | ( | ) |
Gets file specification unicode name.
ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::FileSpecification::GetValue | ( | System::String | key | ) |
Gets application-specific parameter.
key | Parameter name. |
|
protected |
|
protected |
ASPOSE_PDF_SHARED_API void Aspose::Pdf::FileSpecification::set_AFRelationship | ( | Aspose::Pdf::AFRelationship | value | ) |
Associated file Relationship.
ASPOSE_PDF_SHARED_API void Aspose::Pdf::FileSpecification::set_Contents | ( | System::SharedPtr< System::IO::Stream > | value | ) |
Sets contents file. This property returns data loaded in memory which may cause Out of memory exception for large data. To decrease memory usage please use StreamContents.
ASPOSE_PDF_SHARED_API void Aspose::Pdf::FileSpecification::set_Description | ( | System::String | value | ) |
Sets text associated with the file specification.
ASPOSE_PDF_SHARED_API void Aspose::Pdf::FileSpecification::set_Encoding | ( | FileEncoding | value | ) |
Sets encoding format. Possible values: Zip - file is compressed with ZIP, None - file is not compressed.
ASPOSE_PDF_SHARED_API void Aspose::Pdf::FileSpecification::set_FileSystem | ( | System::String | value | ) |
Sets name of the file system.
ASPOSE_PDF_SHARED_API void Aspose::Pdf::FileSpecification::set_IncludeContents | ( | bool | value | ) |
If true, contents of the file will be included in the file specification.
ASPOSE_PDF_SHARED_API void Aspose::Pdf::FileSpecification::set_MIMEType | ( | System::String | value | ) |
Gets subtype of the embedded file
ASPOSE_PDF_SHARED_API void Aspose::Pdf::FileSpecification::set_Name | ( | System::String | value | ) |
Sets file specification name.
ASPOSE_PDF_SHARED_API void Aspose::Pdf::FileSpecification::set_Params | ( | System::SharedPtr< FileParams > | value | ) |
Gets file paramteres.
ASPOSE_PDF_SHARED_API void Aspose::Pdf::FileSpecification::set_UnicodeName | ( | System::String | value | ) |
Sets file specification unicode name.
ASPOSE_PDF_SHARED_API void Aspose::Pdf::FileSpecification::SetValue | ( | System::String | key, |
System::String | value | ||
) |
Sets application-specific parameter.
key | Parameter name. |
value | New parameter value. |