Aspose::Page::XPS::DocumentUtils Class Reference

This class provides utilities beyond the formal XPS manipulation API. More...

Inherits System::Object.

Public Member Functions

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsPathGeometryCreateRectangle (System::Drawing::RectangleF rectangle)
 Creates a path geometry representing a rectangle. More...
 
ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsPathGeometryCreateEllipse (System::Drawing::PointF center, float radiusX, float radiusY)
 Creates a path geometry representing an ellipse. More...
 
ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsPathGeometryCreateCircle (System::Drawing::PointF center, float radius)
 Creates a path geometry representing a circle. More...
 
ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsPathGeometryCreateRegularInscribedNGon (int32_t n, System::Drawing::PointF center, float radius)
 Creates a path geometry representing a regular n-gon inscribed in a circle. More...
 
ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsPathGeometryCreateRegularCircumscribedNGon (int32_t n, System::Drawing::PointF center, float radius)
 Creates a path geometry representing a regular n-gon circumscribed around a circle. More...
 
ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsPathGeometryCreatePieSlice (System::Drawing::PointF center, float radius, float startAngle, float endAngle)
 Creates a path geometry representing a circle slice between two radial rays. More...
 
ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsPathGeometryCreateCircularSegment (System::Drawing::PointF center, float radius, float startAngle, float endAngle)
 Creates a path geometry representing a circular segment between two angles. More...
 
ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsPathCreateImage (System::String fileName, System::Drawing::RectangleF imageBox, ImageMode mode=Aspose::Page::XPS::ImageMode::FitToBox)
 Creates a rectangular path filled with an image. 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 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)
 
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

 DocumentUtils (System::SharedPtr< XpsModel::XpsContext > context)
 
 MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (DocumentUtils, CODEPORTING_ARGS(System::SharedPtr< XpsModel::XpsContext > context))
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 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 TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 

Detailed Description

This class provides utilities beyond the formal XPS manipulation API.

Constructor & Destructor Documentation

◆ DocumentUtils()

Aspose::Page::XPS::DocumentUtils::DocumentUtils ( System::SharedPtr< XpsModel::XpsContext context)
protected

Member Function Documentation

◆ CreateCircle()

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsPathGeometry> Aspose::Page::XPS::DocumentUtils::CreateCircle ( System::Drawing::PointF  center,
float  radius 
)

Creates a path geometry representing a circle.

Parameters
centerThe center point of the circle.
radiusThe radius of the circle.
Returns
The XPS path geometry.

◆ CreateCircularSegment()

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsPathGeometry> Aspose::Page::XPS::DocumentUtils::CreateCircularSegment ( System::Drawing::PointF  center,
float  radius,
float  startAngle,
float  endAngle 
)

Creates a path geometry representing a circular segment between two angles.

Parameters
centerThe center of the circle.
radiusThe radius of the circle.
startAngleThe starting angle.
endAngleThe ending angle.
Returns
The XPS path geometry.

◆ CreateEllipse()

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsPathGeometry> Aspose::Page::XPS::DocumentUtils::CreateEllipse ( System::Drawing::PointF  center,
float  radiusX,
float  radiusY 
)

Creates a path geometry representing an ellipse.

Parameters
centerThe center point of the ellipse.
radiusXThe horizontal radius of the ellipse.
radiusYThe vertical radius of the ellipse.
Returns
The XPS path geometry.

◆ CreateImage()

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsPath> Aspose::Page::XPS::DocumentUtils::CreateImage ( System::String  fileName,
System::Drawing::RectangleF  imageBox,
ImageMode  mode = Aspose::Page::XPS::ImageMode::FitToBox 
)

Creates a rectangular path filled with an image.

Parameters
fileNameThe name of the image file.
imageBoxThe image box to fill with the image.
modeImage fit mode.
Returns
The XPS path.

◆ CreatePieSlice()

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsPathGeometry> Aspose::Page::XPS::DocumentUtils::CreatePieSlice ( System::Drawing::PointF  center,
float  radius,
float  startAngle,
float  endAngle 
)

Creates a path geometry representing a circle slice between two radial rays.

Parameters
centerThe center of the circle.
radiusThe radius of the circle.
startAngleThe angle of the starting ray.
endAngleThe angle of the ending ray.
Returns
The XPS path geometry.

◆ CreateRectangle()

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsPathGeometry> Aspose::Page::XPS::DocumentUtils::CreateRectangle ( System::Drawing::RectangleF  rectangle)

Creates a path geometry representing a rectangle.

Parameters
rectangleThe rectangle.
Returns
The XPS path geometry.

◆ CreateRegularCircumscribedNGon()

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsPathGeometry> Aspose::Page::XPS::DocumentUtils::CreateRegularCircumscribedNGon ( int32_t  n,
System::Drawing::PointF  center,
float  radius 
)

Creates a path geometry representing a regular n-gon circumscribed around a circle.

Parameters
nThe number of vertices.
centerThe center of the circle.
radiusThe radius of the circle.
Returns
The XPS path geometry.

◆ CreateRegularInscribedNGon()

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsPathGeometry> Aspose::Page::XPS::DocumentUtils::CreateRegularInscribedNGon ( int32_t  n,
System::Drawing::PointF  center,
float  radius 
)

Creates a path geometry representing a regular n-gon inscribed in a circle.

Parameters
nThe number of vertices.
centerThe center of the circle.
radiusThe radius of the circle.
Returns
The XPS path geometry.

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION()

Aspose::Page::XPS::DocumentUtils::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION ( DocumentUtils  ,
CODEPORTING_ARGS(System::SharedPtr< XpsModel::XpsContext > context)   
)
protected