Represents PUB document, holds all fields and relevant values More...

Inherits Aspose::Pub::Licensing::IVentureLicenseTarget.

Public Member Functions
ASPOSE_PUB_SHARED_API System::SharedPtr< Aspose::Pub::SummaryInfo >	get_SummaryInfo () const
	Summary Info More...

ASPOSE_PUB_SHARED_API System::SharedPtr< DocSummaryInfo >	get_DocumentSummaryInfo () const
	Document Summary Info More...

ASPOSE_PUB_SHARED_API uint32_t	get_Width () const
	Width of document in PUB metrics(EMUs) More...

ASPOSE_PUB_SHARED_API uint32_t	get_Height () const
	Height of document in PUB metrics(EMUs) More...

ASPOSE_PUB_SHARED_API System::ArrayPtr< System::SharedPtr< TextStyle > >	get_DefaultTextStyles ()
	Array of default text styles More...

ASPOSE_PUB_SHARED_API System::ArrayPtr< System::SharedPtr< ParagraphStyle > >	get_DefaultParagraphStyles ()
	Array of default paragraph styles More...

ASPOSE_PUB_SHARED_API int32_t	get_FieldCount ()
	Count of all fields More...

ASPOSE_PUB_SHARED_API System::ArrayPtr< System::String >	get_FontNames ()
	Array of font names More...

ASPOSE_PUB_SHARED_API System::ArrayPtr< System::Drawing::Color >	get_Colors ()
	Array of colors More...

ASPOSE_PUB_SHARED_API void	SetSummaryInfo (System::SharedPtr< Aspose::Pub::SummaryInfo > value)
	Sets summary info More...

ASPOSE_PUB_SHARED_API void	SetDocSummaryInfo (System::SharedPtr< DocSummaryInfo > value)
	Sets document summary info More...

ASPOSE_PUB_SHARED_API void	AddDefaultTextStyle (System::SharedPtr< TextStyle > value)
	Adds default text style More...

ASPOSE_PUB_SHARED_API void	AddDefaultParagraphStyle (System::SharedPtr< ParagraphStyle > value)
	Adds default paragraph style More...

Public Member Functions inherited from Aspose::Pub::Licensing::IVentureLicenseTarget
virtual void	SetVentureLicense (System::SharedPtr< VentureLicense > license)=0

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< System::Collections::Generic::List< System::SharedPtr< ShapeItem > > >	get_ShapeItems () const

System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< DocumentPage > > >	get_Pages () const

uint32_t	get_Id () const

uint8_t	get_MagicVersion () const

System::SharedPtr< System::Collections::Generic::SortedDictionary< uint32_t, System::SharedPtr< ShapeField > > >	get_FieldsByNum () const

System::SharedPtr< System::Collections::Generic::SortedDictionary< uint32_t, System::SharedPtr< GroupField > > >	get_GroupFields () const

System::SharedPtr< System::Collections::Generic::SortedDictionary< uint32_t, System::SharedPtr< ShapeField > > >	get_TextFieldsByParID () const

System::SharedPtr< System::Collections::Generic::SortedDictionary< uint32_t, System::SharedPtr< ShapeServiceField > > >	get_ServiceFields () const

int32_t	get_NextServiceFieldSeqNum ()

System::SharedPtr< System::Collections::Generic::ICollection< uint32_t > >	get_AllFieldNumbers ()

System::SharedPtr< System::Collections::Generic::ICollection< uint32_t > >	get_AllTextParagraphIds ()

System::ArrayPtr< System::SharedPtr< PubEmbeddedFont > >	get_EmbeddedFonts ()

System::ArrayPtr< System::Drawing::Color >	get_Palette ()

System::SharedPtr< System::Collections::Generic::SortedDictionary< uint32_t, System::SharedPtr< Image > > >	get_Images () const

PubFormatVersion	get_FormatVersion () const

bool	get_IsVentureLicensed ()
	Gets venture licensed state of the object. Returns true if font has venture license and false otherwise. More...

	Document ()
	Initializes a new instance of the Document class More...

	MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (Document, CODEPORTING_ARGS())

void	SetMagicVersion (uint8_t value)

void	SetWidth (uint32_t value)
	Sets width of document in PUB metrics(EMUs) More...

void	SetHeight (uint32_t value)
	Sets height of document in PUB metrics(EMUs) More...

void	RemoveDefaultTextStyle (int32_t index)
	Removes default text style with passed style index from collection More...

void	RemoveDefaultParagraphStyle (int32_t index)
	Removes default paragraph style with passed style index from collection More...

void	AddServiceField (System::SharedPtr< ShapeServiceField > field)

void	AddFieldAndNumPair (uint32_t num, System::SharedPtr< ShapeField > field)
	Adds field with number More...

bool	HasFieldWithNum (uint32_t num)
	Detects whether field for number passed exists More...

System::SharedPtr< ShapeField >	GetFieldByNum (uint32_t num)

void	UpdateFieldForNum (uint32_t num, System::SharedPtr< ShapeField > field)

bool	HasFieldGroup (uint32_t num)

void	AddFieldGroup (uint32_t num, System::SharedPtr< GroupField > group)

System::SharedPtr< GroupField >	GetFieldGroup (uint32_t num)

bool	HasTextFieldForParId (uint32_t parId)

void	AddTextFieldAndParIdPair (uint32_t parId, System::SharedPtr< ShapeField > field)

void	UpdateTextFieldForParId (uint32_t parId, System::SharedPtr< ShapeField > field)

System::SharedPtr< ShapeField >	GetTextFieldForParId (uint32_t parId)

void	AddEmbeddedFonts (System::SharedPtr< System::Collections::Generic::ICollection< System::SharedPtr< PubEmbeddedFont >>> fonts)

void	AddFontNames (System::SharedPtr< System::Collections::Generic::ICollection< System::String >> fonts)
	Adds collection of font names into FontNames array More...

void	AddColor (System::Drawing::Color value)
	Adds color More...

void	AddColorToPalette (System::Drawing::Color value)

void	AddImage (System::SharedPtr< Image > image)

void	SetFormatVersion (PubFormatVersion value)

bool	IsInitialized ()

void	SetId (uint32_t value)

void	AddShapeItem (System::SharedPtr< ShapeItem > item)

void	AddPage (System::SharedPtr< DocumentPage > page)

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...

Detailed Description

Represents PUB document, holds all fields and relevant values

Constructor & Destructor Documentation

◆ Document()

Aspose::Pub::Document::Document ( )

protected

Initializes a new instance of the Document class

Member Function Documentation

◆ AddColor()

void Aspose::Pub::Document::AddColor ( System::Drawing::Color value )

protected

Adds color

Parameters

value color value

◆ AddColorToPalette()

void Aspose::Pub::Document::AddColorToPalette ( System::Drawing::Color value )

protected

◆ AddDefaultParagraphStyle()

ASPOSE_PUB_SHARED_API void Aspose::Pub::Document::AddDefaultParagraphStyle ( System::SharedPtr< ParagraphStyle > value )

Adds default paragraph style

Parameters

value paragraph style

◆ AddDefaultTextStyle()

ASPOSE_PUB_SHARED_API void Aspose::Pub::Document::AddDefaultTextStyle ( System::SharedPtr< TextStyle > value )

Adds default text style

Parameters

value text style

◆ AddEmbeddedFonts()

void Aspose::Pub::Document::AddEmbeddedFonts ( System::SharedPtr< System::Collections::Generic::ICollection< System::SharedPtr< PubEmbeddedFont >>> fonts )

protected

◆ AddFieldAndNumPair()

void Aspose::Pub::Document::AddFieldAndNumPair	(	uint32_t	num,
		System::SharedPtr< ShapeField >	field
	)

protected

Adds field with number

Parameters

num	field number
field	field object

◆ AddFieldGroup()

void Aspose::Pub::Document::AddFieldGroup	(	uint32_t	num,
		System::SharedPtr< GroupField >	group
	)

protected

◆ AddFontNames()

void Aspose::Pub::Document::AddFontNames ( System::SharedPtr< System::Collections::Generic::ICollection< System::String >> fonts )

protected

Adds collection of font names into FontNames array

Parameters

fonts Collection of font names to add

◆ AddImage()

void Aspose::Pub::Document::AddImage ( System::SharedPtr< Image > image )

protected

◆ AddPage()

void Aspose::Pub::Document::AddPage ( System::SharedPtr< DocumentPage > page )

protected

◆ AddServiceField()

void Aspose::Pub::Document::AddServiceField ( System::SharedPtr< ShapeServiceField > field )

protected

◆ AddShapeItem()

void Aspose::Pub::Document::AddShapeItem ( System::SharedPtr< ShapeItem > item )

protected

◆ AddTextFieldAndParIdPair()

void Aspose::Pub::Document::AddTextFieldAndParIdPair	(	uint32_t	parId,
		System::SharedPtr< ShapeField >	field
	)

protected

◆ get_AllFieldNumbers()

System::SharedPtr<System::Collections::Generic::ICollection<uint32_t> > Aspose::Pub::Document::get_AllFieldNumbers ( )

protected

◆ get_AllTextParagraphIds()

System::SharedPtr<System::Collections::Generic::ICollection<uint32_t> > Aspose::Pub::Document::get_AllTextParagraphIds ( )

protected

◆ get_Colors()

ASPOSE_PUB_SHARED_API System::ArrayPtr<System::Drawing::Color> Aspose::Pub::Document::get_Colors ( )

Array of colors

◆ get_DefaultParagraphStyles()

ASPOSE_PUB_SHARED_API System::ArrayPtr<System::SharedPtr<ParagraphStyle> > Aspose::Pub::Document::get_DefaultParagraphStyles ( )

Array of default paragraph styles

◆ get_DefaultTextStyles()

ASPOSE_PUB_SHARED_API System::ArrayPtr<System::SharedPtr<TextStyle> > Aspose::Pub::Document::get_DefaultTextStyles ( )

Array of default text styles

◆ get_DocumentSummaryInfo()

ASPOSE_PUB_SHARED_API System::SharedPtr<DocSummaryInfo> Aspose::Pub::Document::get_DocumentSummaryInfo ( ) const

Document Summary Info

◆ get_EmbeddedFonts()

System::ArrayPtr<System::SharedPtr<PubEmbeddedFont> > Aspose::Pub::Document::get_EmbeddedFonts ( )

protected

◆ get_FieldCount()

ASPOSE_PUB_SHARED_API int32_t Aspose::Pub::Document::get_FieldCount ( )

Count of all fields

◆ get_FieldsByNum()

System::SharedPtr<System::Collections::Generic::SortedDictionary<uint32_t, System::SharedPtr<ShapeField> > > Aspose::Pub::Document::get_FieldsByNum ( ) const

protected

◆ get_FontNames()

ASPOSE_PUB_SHARED_API System::ArrayPtr<System::String> Aspose::Pub::Document::get_FontNames ( )

Array of font names

◆ get_FormatVersion()

PubFormatVersion Aspose::Pub::Document::get_FormatVersion ( ) const

protected

◆ get_GroupFields()

System::SharedPtr<System::Collections::Generic::SortedDictionary<uint32_t, System::SharedPtr<GroupField> > > Aspose::Pub::Document::get_GroupFields ( ) const

protected

◆ get_Height()

ASPOSE_PUB_SHARED_API uint32_t Aspose::Pub::Document::get_Height ( ) const

Height of document in PUB metrics(EMUs)

◆ get_Id()

uint32_t Aspose::Pub::Document::get_Id ( ) const

protected

◆ get_Images()

System::SharedPtr<System::Collections::Generic::SortedDictionary<uint32_t, System::SharedPtr<Image> > > Aspose::Pub::Document::get_Images ( ) const

protected

◆ get_IsVentureLicensed()

bool Aspose::Pub::Document::get_IsVentureLicensed ( )

protected

Gets venture licensed state of the object. Returns true if font has venture license and false otherwise.

◆ get_MagicVersion()

uint8_t Aspose::Pub::Document::get_MagicVersion ( ) const

protected

◆ get_NextServiceFieldSeqNum()

int32_t Aspose::Pub::Document::get_NextServiceFieldSeqNum ( )

protected

◆ get_Pages()

System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<DocumentPage> > > Aspose::Pub::Document::get_Pages ( ) const

protected

◆ get_Palette()

System::ArrayPtr<System::Drawing::Color> Aspose::Pub::Document::get_Palette ( )

protected

◆ get_ServiceFields()

System::SharedPtr<System::Collections::Generic::SortedDictionary<uint32_t, System::SharedPtr<ShapeServiceField> > > Aspose::Pub::Document::get_ServiceFields ( ) const

protected

◆ get_ShapeItems()

System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<ShapeItem> > > Aspose::Pub::Document::get_ShapeItems ( ) const

protected

◆ get_SummaryInfo()

ASPOSE_PUB_SHARED_API System::SharedPtr<Aspose::Pub::SummaryInfo> Aspose::Pub::Document::get_SummaryInfo ( ) const

Summary Info

◆ get_TextFieldsByParID()

System::SharedPtr<System::Collections::Generic::SortedDictionary<uint32_t, System::SharedPtr<ShapeField> > > Aspose::Pub::Document::get_TextFieldsByParID ( ) const

protected

◆ get_Width()

ASPOSE_PUB_SHARED_API uint32_t Aspose::Pub::Document::get_Width ( ) const

Width of document in PUB metrics(EMUs)

◆ GetFieldByNum()

System::SharedPtr<ShapeField> Aspose::Pub::Document::GetFieldByNum ( uint32_t num )

protected

◆ GetFieldGroup()

System::SharedPtr<GroupField> Aspose::Pub::Document::GetFieldGroup ( uint32_t num )

protected

◆ GetTextFieldForParId()

System::SharedPtr<ShapeField> Aspose::Pub::Document::GetTextFieldForParId ( uint32_t parId )

protected

◆ HasFieldGroup()

bool Aspose::Pub::Document::HasFieldGroup ( uint32_t num )

protected

◆ HasFieldWithNum()

bool Aspose::Pub::Document::HasFieldWithNum ( uint32_t num )

protected

Detects whether field for number passed exists

Parameters

num

Returns

◆ HasTextFieldForParId()

bool Aspose::Pub::Document::HasTextFieldForParId ( uint32_t parId )

protected

◆ IsInitialized()

bool Aspose::Pub::Document::IsInitialized ( )

protected

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION()

Aspose::Pub::Document::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION	(	Document	,
		CODEPORTING_ARGS()
	)

protected

◆ RemoveDefaultParagraphStyle()

void Aspose::Pub::Document::RemoveDefaultParagraphStyle ( int32_t index )

protected

Removes default paragraph style with passed style index from collection

Parameters

index index of style

◆ RemoveDefaultTextStyle()

void Aspose::Pub::Document::RemoveDefaultTextStyle ( int32_t index )

protected

Removes default text style with passed style index from collection

Parameters

index index of style

◆ SetDocSummaryInfo()

ASPOSE_PUB_SHARED_API void Aspose::Pub::Document::SetDocSummaryInfo ( System::SharedPtr< DocSummaryInfo > value )

Sets document summary info

Parameters

value Document Summary Info value

◆ SetFormatVersion()

void Aspose::Pub::Document::SetFormatVersion ( PubFormatVersion value )

protected

◆ SetHeight()

void Aspose::Pub::Document::SetHeight ( uint32_t value )

protected

Sets height of document in PUB metrics(EMUs)

Parameters

value height value

◆ SetId()

void Aspose::Pub::Document::SetId ( uint32_t value )

protected

◆ SetMagicVersion()

void Aspose::Pub::Document::SetMagicVersion ( uint8_t value )

protected

◆ SetSummaryInfo()

ASPOSE_PUB_SHARED_API void Aspose::Pub::Document::SetSummaryInfo ( System::SharedPtr< Aspose::Pub::SummaryInfo > value )

Sets summary info

Parameters

value Summary Info value

◆ SetWidth()

void Aspose::Pub::Document::SetWidth ( uint32_t value )

protected

Sets width of document in PUB metrics(EMUs)

Parameters

value width value

◆ UpdateFieldForNum()

void Aspose::Pub::Document::UpdateFieldForNum	(	uint32_t	num,
		System::SharedPtr< ShapeField >	field
	)

protected

◆ UpdateTextFieldForParId()

void Aspose::Pub::Document::UpdateTextFieldForParId	(	uint32_t	parId,
		System::SharedPtr< ShapeField >	field
	)

protected

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Document()

Member Function Documentation

◆ AddColor()

◆ AddColorToPalette()

◆ AddDefaultParagraphStyle()

◆ AddDefaultTextStyle()

◆ AddEmbeddedFonts()

◆ AddFieldAndNumPair()

◆ AddFieldGroup()

◆ AddFontNames()

◆ AddImage()

◆ AddPage()

◆ AddServiceField()

◆ AddShapeItem()

◆ AddTextFieldAndParIdPair()

◆ get_AllFieldNumbers()

◆ get_AllTextParagraphIds()

◆ get_Colors()

◆ get_DefaultParagraphStyles()

◆ get_DefaultTextStyles()

◆ get_DocumentSummaryInfo()

◆ get_EmbeddedFonts()

◆ get_FieldCount()

◆ get_FieldsByNum()

◆ get_FontNames()

◆ get_FormatVersion()

◆ get_GroupFields()

◆ get_Height()

◆ get_Id()

◆ get_Images()

◆ get_IsVentureLicensed()

◆ get_MagicVersion()

◆ get_NextServiceFieldSeqNum()

◆ get_Pages()

◆ get_Palette()

◆ get_ServiceFields()

◆ get_ShapeItems()

◆ get_SummaryInfo()

◆ get_TextFieldsByParID()

◆ get_Width()

◆ GetFieldByNum()

◆ GetFieldGroup()

◆ GetTextFieldForParId()

◆ HasFieldGroup()

◆ HasFieldWithNum()

◆ HasTextFieldForParId()

◆ IsInitialized()

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION()

◆ RemoveDefaultParagraphStyle()

◆ RemoveDefaultTextStyle()

◆ SetDocSummaryInfo()

◆ SetFormatVersion()

◆ SetHeight()

◆ SetId()

◆ SetMagicVersion()

◆ SetSummaryInfo()

◆ SetWidth()

◆ UpdateFieldForNum()

◆ UpdateTextFieldForParId()