Aspose::Pdf::Text::FontCollection Class Referencefinal

Represents font collection. More...

Inherits System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::Text::Font > >.

Public Member Functions

int32_t get_Count () const
 Gets the number of Font object elements actually contained in the collection. More...
 
System::SharedPtr< System::Objectget_SyncRoot ()
 Gets an object that can be used to synchronize access to the collection. More...
 
bool get_IsSynchronized ()
 Gets a value indicating whether access to the collection is synchronized (thread safe). More...
 
bool get_IsReadOnly () const
 Gets a value indicating whether collection is read-only More...
 
System::SharedPtr< System::Collections::Generic::IEnumerator< System::SharedPtr< Font > > > GetEnumerator ()
 Returns an enumerator for the entire collection. More...
 
void CopyTo (System::ArrayPtr< System::SharedPtr< Font >> array, int32_t index)
 Copies the entire collection to a compatible one-dimensional Array, starting at the specified index of the target array More...
 
void Add (System::SharedPtr< Font > newFont, System::String &resName)
 Adds new font to font resources and returns automatically assigned name of font resource. More...
 
System::SharedPtr< Fontidx_get (int32_t index)
 Gets the font element at the specified index. More...
 
System::SharedPtr< Fontidx_get (System::String name)
 Gets font from the collection by font name. Exception is thrown if font was not found. More...
 
bool Contains (System::String const &name) const
 Checks if font exists in font collection. More...
 
void Add (System::SharedPtr< Font > const &item)
 Adds Font into collection. More...
 
bool Contains (System::SharedPtr< Font > const &item) const
 Determines whether the collection contains a specific value. More...
 
bool Remove (System::SharedPtr< Font > const &item)
 Deletes specified item from collection. More...
 
- Public Member Functions inherited from System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::Text::Font > >
virtual void CopyTo (System::ArrayPtr< System::SharedPtr< Aspose::Pdf::Text::Font > > array, int arrayIndex)=0
 
ICollectionoperator= (ICollection &&)
 
ICollectionoperator= (const ICollection &)
 
 ICollection ()
 Default constructor. More...
 
 ICollection (const ICollection &)
 Copy constructor. More...
 
 ICollection (ICollection &&)
 Move constructor. More...
 
virtual ~ICollection ()
 Destructor. 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< Aspose::Pdf::Engine::CommonData::PageContent::IResourceDictionary > get_ResourceDictionary ()
 
System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary > get_FontsDictionary () const
 
bool get_ResourceMode ()
 
 FontCollection (System::SharedPtr< Document > doc)
 Initializes empty font collection object More...
 
 FontCollection (System::SharedPtr< Aspose::Pdf::Engine::CommonData::PageContent::IResourceDictionary > resourceDictionary)
 Initializes collection object with resource dictionary object More...
 
void Delete (int32_t index)
 Deletes the font element at the specified index. More...
 
void Delete (System::String fontResourceName)
 Deletes Font with resource name specified More...
 
void Clear ()
 Clears all the collection contents. To reinitialize collection data use Init() methods. More...
 
void Init (System::SharedPtr< Aspose::Pdf::Engine::CommonData::PageContent::IResourceDictionary > resourceDictionary)
 Initializes collection object with resource dictionary object. More...
 
void Init ()
 Initializes collection object with empty resources. More...
 
System::SharedPtr< Aspose::Pdf::Collections::AsposeHashDictionary< System::String, System::SharedPtr< Font > > > GetHash ()
 
void Add (System::String resName, System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > newFont)
 Add new font to font collection. More...
 
void Add (System::String resName, System::String baseFontName)
 Adds to font resources new font entry with specified base font name. More...
 
virtual ~FontCollection ()
 
- Protected Member Functions inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Pdf::Text::Font > >
 ~IEnumerable () override
 Destructor. More...
 

Additional Inherited Members

- Public Types inherited from System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::Text::Font > >
typedef System::SharedPtr< Aspose::Pdf::Text::FontValueType
 Value type name. More...
 
typedef ICollection< System::SharedPtr< Aspose::Pdf::Text::Font > > ThisType
 Collection type name. More...
 
- Public Types inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Pdf::Text::Font > >
typedef IEnumerator< System::SharedPtr< Aspose::Pdf::Text::Font > > IEnumeratorType
 Enumerator type. More...
 
- 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

Represents font collection.

Font collections represented by FontCollection class are used in several scenarios. For example, in resources with Resources::Fonts property.

The example demonstrates how to make all font declared on page as embedded.

// Open document
Document doc = new Document(@"D:\Tests\input.pdf");
// ensure all fonts declared on page resources are embedded
// note that if fonts are declared on form resources they are not accessible from page resources
foreach(Aspose.Pdf.Txt.Font font in doc.Pages[1].Resources.Fonts)
{
if(!font.IsEmbedded)
font.IsEmbedded = true;
}
doc.Save(@"D:\Tests\input.pdf");

Constructor & Destructor Documentation

◆ FontCollection() [1/2]

Aspose::Pdf::Text::FontCollection::FontCollection ( System::SharedPtr< Document doc)
protected

Initializes empty font collection object

◆ FontCollection() [2/2]

Aspose::Pdf::Text::FontCollection::FontCollection ( System::SharedPtr< Aspose::Pdf::Engine::CommonData::PageContent::IResourceDictionary >  resourceDictionary)
protected

Initializes collection object with resource dictionary object

◆ ~FontCollection()

virtual Aspose::Pdf::Text::FontCollection::~FontCollection ( )
protectedvirtual

Member Function Documentation

◆ Add() [1/4]

void Aspose::Pdf::Text::FontCollection::Add ( System::SharedPtr< Font newFont,
System::String resName 
)

Adds new font to font resources and returns automatically assigned name of font resource.

Parameters
newFontFont object.
resNameThe automatically assigned resource item name.

◆ Add() [2/4]

void Aspose::Pdf::Text::FontCollection::Add ( System::SharedPtr< Font > const &  item)
virtual

Adds Font into collection.

Parameters
itemFont to add into collection

Implements System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::Text::Font > >.

◆ Add() [3/4]

void Aspose::Pdf::Text::FontCollection::Add ( System::String  resName,
System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject >  newFont 
)
protected

Add new font to font collection.

Parameters
resName
newFont

◆ Add() [4/4]

void Aspose::Pdf::Text::FontCollection::Add ( System::String  resName,
System::String  baseFontName 
)
protected

Adds to font resources new font entry with specified base font name.

Parameters
resName
baseFontName

◆ Clear()

void Aspose::Pdf::Text::FontCollection::Clear ( )
protectedvirtual

Clears all the collection contents. To reinitialize collection data use Init() methods.

Implements System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::Text::Font > >.

◆ Contains() [1/2]

bool Aspose::Pdf::Text::FontCollection::Contains ( System::String const &  name) const

Checks if font exists in font collection.

Parameters
nameFont name.
Returns
True in case collection contains the font with specified name.

◆ Contains() [2/2]

bool Aspose::Pdf::Text::FontCollection::Contains ( System::SharedPtr< Font > const &  item) const
virtual

Determines whether the collection contains a specific value.

Parameters
itemThe object to locate in the collection
Returns
true if item is found in the collection; otherwise, false.

Implements System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::Text::Font > >.

◆ CopyTo()

void Aspose::Pdf::Text::FontCollection::CopyTo ( System::ArrayPtr< System::SharedPtr< Font >>  array,
int32_t  index 
)

Copies the entire collection to a compatible one-dimensional Array, starting at the specified index of the target array

Parameters
arrayArray of objects which will be copied.
indexStarting index from which copying will be started.

◆ Delete() [1/2]

void Aspose::Pdf::Text::FontCollection::Delete ( int32_t  index)
protected

Deletes the font element at the specified index.

◆ Delete() [2/2]

void Aspose::Pdf::Text::FontCollection::Delete ( System::String  fontResourceName)
protected

Deletes Font with resource name specified

Parameters
fontResourceNamename of Font resurce

◆ get_Count()

int32_t Aspose::Pdf::Text::FontCollection::get_Count ( ) const
virtual

Gets the number of Font object elements actually contained in the collection.

Implements System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::Text::Font > >.

◆ get_FontsDictionary()

System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfDictionary> Aspose::Pdf::Text::FontCollection::get_FontsDictionary ( ) const
protected

◆ get_IsReadOnly()

bool Aspose::Pdf::Text::FontCollection::get_IsReadOnly ( ) const
virtual

Gets a value indicating whether collection is read-only

Reimplemented from System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::Text::Font > >.

◆ get_IsSynchronized()

bool Aspose::Pdf::Text::FontCollection::get_IsSynchronized ( )

Gets a value indicating whether access to the collection is synchronized (thread safe).

◆ get_ResourceDictionary()

System::SharedPtr<Aspose::Pdf::Engine::CommonData::PageContent::IResourceDictionary> Aspose::Pdf::Text::FontCollection::get_ResourceDictionary ( )
protected

◆ get_ResourceMode()

bool Aspose::Pdf::Text::FontCollection::get_ResourceMode ( )
protected

◆ get_SyncRoot()

System::SharedPtr<System::Object> Aspose::Pdf::Text::FontCollection::get_SyncRoot ( )

Gets an object that can be used to synchronize access to the collection.

◆ GetEnumerator()

System::SharedPtr<System::Collections::Generic::IEnumerator<System::SharedPtr<Font> > > Aspose::Pdf::Text::FontCollection::GetEnumerator ( )
virtual

Returns an enumerator for the entire collection.

Returns
Enumerator object.

Implements System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Pdf::Text::Font > >.

◆ GetHash()

System::SharedPtr<Aspose::Pdf::Collections::AsposeHashDictionary<System::String, System::SharedPtr<Font> > > Aspose::Pdf::Text::FontCollection::GetHash ( )
protected

◆ idx_get() [1/2]

System::SharedPtr<Font> Aspose::Pdf::Text::FontCollection::idx_get ( int32_t  index)

Gets the font element at the specified index.

Parameters
indexIndex within the collection.
Returns
Font object.

◆ idx_get() [2/2]

System::SharedPtr<Font> Aspose::Pdf::Text::FontCollection::idx_get ( System::String  name)

Gets font from the collection by font name. Exception is thrown if font was not found.

Parameters
nameName of the font.
Returns
Found font.

◆ Init() [1/2]

void Aspose::Pdf::Text::FontCollection::Init ( System::SharedPtr< Aspose::Pdf::Engine::CommonData::PageContent::IResourceDictionary >  resourceDictionary)
protected

Initializes collection object with resource dictionary object.

◆ Init() [2/2]

void Aspose::Pdf::Text::FontCollection::Init ( )
protected

Initializes collection object with empty resources.

◆ Remove()

bool Aspose::Pdf::Text::FontCollection::Remove ( System::SharedPtr< Font > const &  item)
virtual

Deletes specified item from collection.

Parameters
itemThe object to delete
Returns
true if item was deleted from collection; otherwise, false.

Implements System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::Text::Font > >.