Represents image. More...

Inherits Aspose::Pdf::BaseParagraph.

Public Member Functions

ASPOSE_PDF_SHARED_API System::String get_File () const
 Gets the image file. More...
 
ASPOSE_PDF_SHARED_API void set_File (System::String value)
 Sets the image file. More...
 
ASPOSE_PDF_SHARED_API double get_FixWidth () const
 Gets the image width. More...
 
ASPOSE_PDF_SHARED_API void set_FixWidth (double value)
 Sets the image width. More...
 
ASPOSE_PDF_SHARED_API double get_FixHeight () const
 Gets the image height. More...
 
ASPOSE_PDF_SHARED_API void set_FixHeight (double value)
 Sets the image height. More...
 
ASPOSE_PDF_SHARED_API ImageFileType get_FileType () const
 Gets the image file type. More...
 
ASPOSE_PDF_SHARED_API void set_FileType (ImageFileType value)
 Sets the image file type. More...
 
ASPOSE_PDF_SHARED_API double get_ImageScale () const
 Gets the image scale. More...
 
ASPOSE_PDF_SHARED_API void set_ImageScale (double value)
 Sets the image scale. More...
 
ASPOSE_PDF_SHARED_API const System::SharedPtr< System::IO::Stream > & get_ImageStream () const
 Gets the image stream. More...
 
ASPOSE_PDF_SHARED_API void set_ImageStream (System::SharedPtr< System::IO::Stream > value)
 Sets the image stream. More...
 
ASPOSE_PDF_SHARED_API bool get_IsApplyResolution () const
 Gets a bool value that indicates whether the image use resolution during generation More...
 
ASPOSE_PDF_SHARED_API void set_IsApplyResolution (bool value)
 Sets a bool value that indicates whether the image use resolution during generation More...
 
ASPOSE_PDF_SHARED_API bool get_IsBlackWhite () const
 Gets a bool value that indicates whether the image is forced to be black-and-white. If TIFF image of CCITT subformat is used, this property must be set to true. More...
 
ASPOSE_PDF_SHARED_API void set_IsBlackWhite (bool value)
 Sets a bool value that indicates whether the image is forced to be black-and-white. If TIFF image of CCITT subformat is used, this property must be set to true. More...
 
ASPOSE_PDF_SHARED_API const System::SharedPtr< Text::TextFragment > & get_Title () const
 Gets a string value that indicates the title of the image. More...
 
ASPOSE_PDF_SHARED_API void set_Title (System::SharedPtr< Text::TextFragment > value)
 Sets a string value that indicates the title of the image. More...
 
ASPOSE_PDF_SHARED_API Image ()
 
ASPOSE_PDF_SHARED_API System::SharedPtr< System::ObjectClone () override
 Clone the image. More...
 
- Public Member Functions inherited from Aspose::Pdf::BaseParagraph
virtual ASPOSE_PDF_SHARED_API Aspose::Pdf::VerticalAlignment get_VerticalAlignment ()
 Gets a vertical alignment of paragraph More...
 
virtual ASPOSE_PDF_SHARED_API void set_VerticalAlignment (Aspose::Pdf::VerticalAlignment value)
 Sets a vertical alignment of paragraph More...
 
virtual ASPOSE_PDF_SHARED_API Aspose::Pdf::HorizontalAlignment get_HorizontalAlignment ()
 Gets a horizontal alignment of paragraph More...
 
virtual ASPOSE_PDF_SHARED_API void set_HorizontalAlignment (Aspose::Pdf::HorizontalAlignment value)
 Sets a horizontal alignment of paragraph More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< MarginInfoget_Margin ()
 Gets a outer margin for paragraph (for pdf generation) More...
 
ASPOSE_PDF_SHARED_API void set_Margin (System::SharedPtr< MarginInfo > value)
 Sets a outer margin for paragraph (for pdf generation) More...
 
ASPOSE_PDF_SHARED_API bool get_IsFirstParagraphInColumn () const
 Gets a bool value that indicates whether this paragraph will be at next column. Default is false.(for pdf generation) More...
 
ASPOSE_PDF_SHARED_API void set_IsFirstParagraphInColumn (bool value)
 Sets a bool value that indicates whether this paragraph will be at next column. Default is false.(for pdf generation) More...
 
ASPOSE_PDF_SHARED_API bool get_IsKeptWithNext () const
 Gets a bool value that indicates whether current paragraph remains in the same page along with next paragraph. Default is false.(for pdf generation) More...
 
ASPOSE_PDF_SHARED_API void set_IsKeptWithNext (bool value)
 Sets a bool value that indicates whether current paragraph remains in the same page along with next paragraph. Default is false.(for pdf generation) More...
 
ASPOSE_PDF_SHARED_API bool get_IsInNewPage () const
 Gets a bool value that force this paragraph generates at new page. Default is false.(for pdf generation) More...
 
ASPOSE_PDF_SHARED_API void set_IsInNewPage (bool value)
 Sets a bool value that force this paragraph generates at new page. Default is false.(for pdf generation) More...
 
ASPOSE_PDF_SHARED_API bool get_IsInLineParagraph () const
 Gets a paragraph is inline. Default is false.(for pdf generation) More...
 
ASPOSE_PDF_SHARED_API void set_IsInLineParagraph (bool value)
 Sets a paragraph is inline. Default is false.(for pdf generation) More...
 
virtual ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Hyperlinkget_Hyperlink ()
 Gets the fragment hyperlink(for pdf generator). More...
 
virtual ASPOSE_PDF_SHARED_API void set_Hyperlink (System::SharedPtr< Aspose::Pdf::Hyperlink > value)
 Sets the fragment hyperlink(for pdf generator). More...
 
ASPOSE_PDF_SHARED_API int32_t get_ZIndex () const
 Gets a int value that indicates the Z-order of the graph. A graph with larger ZIndex will be placed over the graph with smaller ZIndex. ZIndex can be negative. Graph with negative ZIndex will be placed behind the text in the page. More...
 
ASPOSE_PDF_SHARED_API void set_ZIndex (int32_t value)
 Sets a int value that indicates the Z-order of the graph. A graph with larger ZIndex will be placed over the graph with smaller ZIndex. ZIndex can be negative. Graph with negative ZIndex will be placed behind the text in the page. More...
 
ASPOSE_PDF_SHARED_API BaseParagraph ()
 
- 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 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 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 (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...
 

Static Public Member Functions

static ASPOSE_PDF_SHARED_API System::String GetMimeType (System::SharedPtr< System::Drawing::Image > i)
 Returns mime type for image. 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 ()
 Implements C# typeof(System.Object) construct. More...
 

Protected Member Functions

System::SharedPtr< Rectangleget_BBox () const
 
System::String get_SerializationTag () const
 Gets a custom tag for serialization. More...
 
void set_SerializationTag (System::String value)
 Sets a custom tag for serialization. More...
 
void SetTaggedInfo (int32_t MCID)
 
bool Process (double &curX, double &rightX, double &curY, bool isScaleParagraph, System::SharedPtr< MarginInfo > marginInfo, double realWidth, double height, System::SharedPtr< Page > page, System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator >>> operators, bool isCalculatedMode, bool isNextParagraphInline, bool isFooter, System::SharedPtr< Paragraphs > &paragraphs, double footNoteHeight, double bottomY, int32_t processedParagraphsCount)
 Process image generation. More...
 
ASPOSE_PDF_SHARED_API void Serialize (System::SharedPtr< System::Xml::XmlTextWriter > writer) override
 
ASPOSE_PDF_SHARED_API void Deserialize (System::SharedPtr< System::Xml::XmlReader > reader) override
 
- Protected Member Functions inherited from Aspose::Pdf::BaseParagraph
System::String get_Id () const
 Gets a paragraph id. More...
 
void set_Id (System::String value)
 Sets a paragraph id. More...
 
const System::SharedPtr< Annotations::LinkAnnotation > & get_ReferencedFrom () const
 Gets the fragment hyperlink(for pdf generator internal use). More...
 
void set_ReferencedFrom (System::SharedPtr< Annotations::LinkAnnotation > value)
 Sets the fragment hyperlink(for pdf generator internal use). More...
 
void ChangePosition (double &curX, double &curY, double newX, double newY, bool isNextParagraphInline)
 
void ProcessHyperlink (System::SharedPtr< Page > page, System::SharedPtr< Rectangle > rect)
 

Static Protected Member Functions

static System::String GetFileName (System::String imageFile)
 Get file from url and local path More...
 
- Static Protected Member Functions inherited from Aspose::Pdf::BaseParagraph
static bool get_IsZIndexSet ()
 Gets the fragment hyperlink(for pdf generator performance internal use). More...
 
static void set_IsZIndexSet (bool value)
 Sets the fragment hyperlink(for pdf generator performance internal use). More...
 

Protected Attributes

bool isTagged
 
int32_t MCID
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 

Detailed Description

Represents image.

Constructor & Destructor Documentation

◆ Image()

ASPOSE_PDF_SHARED_API Aspose::Pdf::Image::Image ( )

Member Function Documentation

◆ Clone()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Object> Aspose::Pdf::Image::Clone ( )
overridevirtual

Clone the image.

Returns
The cloned object

Reimplemented from Aspose::Pdf::BaseParagraph.

◆ Deserialize()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Image::Deserialize ( System::SharedPtr< System::Xml::XmlReader reader)
overrideprotectedvirtual

Reimplemented from Aspose::Pdf::BaseParagraph.

◆ get_BBox()

System::SharedPtr<Rectangle> Aspose::Pdf::Image::get_BBox ( ) const
protected

◆ get_File()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Image::get_File ( ) const

Gets the image file.

◆ get_FileType()

ASPOSE_PDF_SHARED_API ImageFileType Aspose::Pdf::Image::get_FileType ( ) const

Gets the image file type.

◆ get_FixHeight()

ASPOSE_PDF_SHARED_API double Aspose::Pdf::Image::get_FixHeight ( ) const

Gets the image height.

◆ get_FixWidth()

ASPOSE_PDF_SHARED_API double Aspose::Pdf::Image::get_FixWidth ( ) const

Gets the image width.

◆ get_ImageScale()

ASPOSE_PDF_SHARED_API double Aspose::Pdf::Image::get_ImageScale ( ) const

Gets the image scale.

◆ get_ImageStream()

ASPOSE_PDF_SHARED_API const System::SharedPtr<System::IO::Stream>& Aspose::Pdf::Image::get_ImageStream ( ) const

Gets the image stream.

◆ get_IsApplyResolution()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Image::get_IsApplyResolution ( ) const

Gets a bool value that indicates whether the image use resolution during generation

◆ get_IsBlackWhite()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Image::get_IsBlackWhite ( ) const

Gets a bool value that indicates whether the image is forced to be black-and-white. If TIFF image of CCITT subformat is used, this property must be set to true.

◆ get_SerializationTag()

System::String Aspose::Pdf::Image::get_SerializationTag ( ) const
protected

Gets a custom tag for serialization.

◆ get_Title()

ASPOSE_PDF_SHARED_API const System::SharedPtr<Text::TextFragment>& Aspose::Pdf::Image::get_Title ( ) const

Gets a string value that indicates the title of the image.

◆ GetFileName()

static System::String Aspose::Pdf::Image::GetFileName ( System::String  imageFile)
staticprotected

Get file from url and local path

◆ GetMimeType()

static ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Image::GetMimeType ( System::SharedPtr< System::Drawing::Image i)
static

Returns mime type for image.

Parameters
iImage object/
Returns
Mime type as string if found; otherwise, "image/unknown" value.

◆ Process()

bool Aspose::Pdf::Image::Process ( double &  curX,
double &  rightX,
double &  curY,
bool  isScaleParagraph,
System::SharedPtr< MarginInfo marginInfo,
double  realWidth,
double  height,
System::SharedPtr< Page page,
System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator >>>  operators,
bool  isCalculatedMode,
bool  isNextParagraphInline,
bool  isFooter,
System::SharedPtr< Paragraphs > &  paragraphs,
double  footNoteHeight,
double  bottomY,
int32_t  processedParagraphsCount 
)
protected

Process image generation.

◆ Serialize()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Image::Serialize ( System::SharedPtr< System::Xml::XmlTextWriter writer)
overrideprotectedvirtual

Reimplemented from Aspose::Pdf::BaseParagraph.

◆ set_File()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Image::set_File ( System::String  value)

Sets the image file.

◆ set_FileType()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Image::set_FileType ( ImageFileType  value)

Sets the image file type.

◆ set_FixHeight()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Image::set_FixHeight ( double  value)

Sets the image height.

◆ set_FixWidth()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Image::set_FixWidth ( double  value)

Sets the image width.

◆ set_ImageScale()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Image::set_ImageScale ( double  value)

Sets the image scale.

◆ set_ImageStream()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Image::set_ImageStream ( System::SharedPtr< System::IO::Stream value)

Sets the image stream.

◆ set_IsApplyResolution()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Image::set_IsApplyResolution ( bool  value)

Sets a bool value that indicates whether the image use resolution during generation

◆ set_IsBlackWhite()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Image::set_IsBlackWhite ( bool  value)

Sets a bool value that indicates whether the image is forced to be black-and-white. If TIFF image of CCITT subformat is used, this property must be set to true.

◆ set_SerializationTag()

void Aspose::Pdf::Image::set_SerializationTag ( System::String  value)
protected

Sets a custom tag for serialization.

◆ set_Title()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Image::set_Title ( System::SharedPtr< Text::TextFragment value)

Sets a string value that indicates the title of the image.

◆ SetTaggedInfo()

void Aspose::Pdf::Image::SetTaggedInfo ( int32_t  MCID)
protected

Member Data Documentation

◆ isTagged

bool Aspose::Pdf::Image::isTagged
protected

◆ MCID

int32_t Aspose::Pdf::Image::MCID
protected