Aspose::Pdf::FileSpecification Class Referencefinal

Class representing embedded file. More...

Inherits System::IDisposable.

Public Member Functions

FileEncoding get_Encoding ()
 Gets encoding format. Possible values: Zip - file is compressed with ZIP, None - file is not compressed. More...
 
void set_Encoding (FileEncoding value)
 Sets encoding format. Possible values: Zip - file is compressed with ZIP, None - file is not compressed. More...
 
bool get_IncludeContents ()
 If true, contents of the file will be included in the file specification. More...
 
void set_IncludeContents (bool value)
 If true, contents of the file will be included in the file specification. More...
 
System::String get_Description ()
 Gets text associated with the file specification. More...
 
void set_Description (System::String value)
 Sets text associated with the file specification. More...
 
System::SharedPtr< System::IO::Streamget_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...
 
System::SharedPtr< System::IO::Streamget_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...
 
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...
 
System::SharedPtr< FileParamsget_Params ()
 Gets file paramteres. More...
 
void set_Params (System::SharedPtr< FileParams > value)
 Gets file paramteres. More...
 
System::String get_MIMEType ()
 Gets subtype of the embedded file More...
 
void set_MIMEType (System::String value)
 Gets subtype of the embedded file More...
 
System::String get_Name ()
 Gets file specification name. More...
 
void set_Name (System::String value)
 Sets file specification name. More...
 
System::String get_UnicodeName ()
 Gets file specification unicode name. More...
 
void set_UnicodeName (System::String value)
 Sets file specification unicode name. More...
 
System::String get_FileSystem ()
 Gets name of the file system. More...
 
void set_FileSystem (System::String value)
 Sets name of the file system. More...
 
 FileSpecification (System::String file)
 Constructor for FileSpecification More...
 
 FileSpecification (System::SharedPtr< System::IO::Stream > stream, System::String name)
 Constructor for file specification. More...
 
 FileSpecification (System::String file, System::String description)
 Constructor for FileSpecification. More...
 
 FileSpecification (System::SharedPtr< System::IO::Stream > stream, System::String name, System::String description)
 Constructor for FileSpecification. More...
 
 FileSpecification (System::String fileName, System::SharedPtr< Annotations::Annotation > annot)
 Constructor for FileSpecification. More...
 
 FileSpecification ()
 Create new empty file specification. More...
 
void Dispose ()
 Does nothing. 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...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 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 refernce 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 int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () ASPOSE_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 TypeInfoGetType () 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 (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

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 ()
 
 FileSpecification (System::SharedPtr< Engine::Data::IPdfPrimitive > specification)
 
void SendMeteredInformation ()
 
System::SharedPtr< Engine::Data::IPdfPrimitive > createFileSpecification (System::SharedPtr< Engine::Data::ITrailerable > trailer)
 Creates file specification More...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. 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 TypeInfoType ()
 Impleemnts C# typeof(System.Object) construct. More...
 

Detailed Description

Class representing embedded file.

Constructor & Destructor Documentation

◆ FileSpecification() [1/7]

Aspose::Pdf::FileSpecification::FileSpecification ( System::String  file)

Constructor for FileSpecification

Parameters
fileFile path.

◆ FileSpecification() [2/7]

Aspose::Pdf::FileSpecification::FileSpecification ( System::SharedPtr< System::IO::Stream stream,
System::String  name 
)

Constructor for file specification.

Parameters
streamStream containing data file.
nameFile specification.

◆ FileSpecification() [3/7]

Aspose::Pdf::FileSpecification::FileSpecification ( System::String  file,
System::String  description 
)

Constructor for FileSpecification.

Parameters
fileFile path.
descriptionFile description.

◆ FileSpecification() [4/7]

Aspose::Pdf::FileSpecification::FileSpecification ( System::SharedPtr< System::IO::Stream stream,
System::String  name,
System::String  description 
)

Constructor for FileSpecification.

Parameters
streamStream to be used in the document.
nameA file specification string.
descriptionFile description.

◆ FileSpecification() [5/7]

Aspose::Pdf::FileSpecification::FileSpecification ( System::String  fileName,
System::SharedPtr< Annotations::Annotation annot 
)

Constructor for FileSpecification.

Parameters
fileNameFile path.
annotThe annotation.

◆ FileSpecification() [6/7]

Aspose::Pdf::FileSpecification::FileSpecification ( )

Create new empty file specification.

◆ FileSpecification() [7/7]

Aspose::Pdf::FileSpecification::FileSpecification ( System::SharedPtr< Engine::Data::IPdfPrimitive >  specification)
protected

Member Function Documentation

◆ createFileSpecification()

System::SharedPtr<Engine::Data::IPdfPrimitive> Aspose::Pdf::FileSpecification::createFileSpecification ( System::SharedPtr< Engine::Data::ITrailerable >  trailer)
protected

Creates file specification

Parameters
trailerTrailerable object.
Returns
PDF object which describes file specification

◆ Dispose()

void Aspose::Pdf::FileSpecification::Dispose ( )
virtual

Does nothing.

Reimplemented from System::IDisposable.

◆ get_Contents()

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.

◆ get_Description()

System::String Aspose::Pdf::FileSpecification::get_Description ( )

Gets text associated with the file specification.

◆ get_Encoding()

FileEncoding Aspose::Pdf::FileSpecification::get_Encoding ( )

Gets encoding format. Possible values: Zip - file is compressed with ZIP, None - file is not compressed.

◆ get_EngineDict()

System::SharedPtr<Engine::Data::IPdfDictionary> Aspose::Pdf::FileSpecification::get_EngineDict ( )
protected

Pdf dictionary containing information about the file.

◆ get_EngineObj()

System::SharedPtr<Engine::Data::IPdfObject> Aspose::Pdf::FileSpecification::get_EngineObj ( )
protected

◆ get_FileSystem()

System::String Aspose::Pdf::FileSpecification::get_FileSystem ( )

Gets name of the file system.

◆ get_IncludeContents()

bool Aspose::Pdf::FileSpecification::get_IncludeContents ( )

If true, contents of the file will be included in the file specification.

◆ get_MIMEType()

System::String Aspose::Pdf::FileSpecification::get_MIMEType ( )

Gets subtype of the embedded file

◆ get_Name()

System::String Aspose::Pdf::FileSpecification::get_Name ( )

Gets file specification name.

◆ get_Params()

System::SharedPtr<FileParams> Aspose::Pdf::FileSpecification::get_Params ( )

Gets file paramteres.

◆ get_StreamContents()

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.

◆ get_UnicodeName()

System::String Aspose::Pdf::FileSpecification::get_UnicodeName ( )

Gets file specification unicode name.

◆ SendMeteredInformation()

void Aspose::Pdf::FileSpecification::SendMeteredInformation ( )
protected

◆ set_Contents()

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.

◆ set_Description()

void Aspose::Pdf::FileSpecification::set_Description ( System::String  value)

Sets text associated with the file specification.

◆ set_Encoding()

void Aspose::Pdf::FileSpecification::set_Encoding ( FileEncoding  value)

Sets encoding format. Possible values: Zip - file is compressed with ZIP, None - file is not compressed.

◆ set_FileSystem()

void Aspose::Pdf::FileSpecification::set_FileSystem ( System::String  value)

Sets name of the file system.

◆ set_IncludeContents()

void Aspose::Pdf::FileSpecification::set_IncludeContents ( bool  value)

If true, contents of the file will be included in the file specification.

◆ set_MIMEType()

void Aspose::Pdf::FileSpecification::set_MIMEType ( System::String  value)

Gets subtype of the embedded file

◆ set_Name()

void Aspose::Pdf::FileSpecification::set_Name ( System::String  value)

Sets file specification name.

◆ set_Params()

void Aspose::Pdf::FileSpecification::set_Params ( System::SharedPtr< FileParams value)

Gets file paramteres.

◆ set_UnicodeName()

void Aspose::Pdf::FileSpecification::set_UnicodeName ( System::String  value)

Sets file specification unicode name.