Describes the JobStapleAllDocuments and DocumentStaple features options. More...

Inherits Aspose::Page::XPS::XpsMetadata::Option.

Public Member Functions
ASPOSE_PAGE_SHARED_API	StapleOption (System::String optionName, const System::ArrayPtr< System::SharedPtr< Staple::IStapleOptionItem >> &items)
	Creates a new instance. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< Staple::StapleOption >	Add (const System::ArrayPtr< System::SharedPtr< Staple::IStapleOptionItem >> &items)
	Adds an array of IStapleOptionItem instances to the feature. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< Staple::StapleOption >	SetAngle (int32_t angle)
	Sets an Angle scored property value. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< Staple::StapleOption >	SetSheetCapacity (int32_t sheetCapacity)
	Sets an SheetCapacity scored property value. More...

Public Member Functions inherited from Aspose::Page::XPS::XpsMetadata::Option
ASPOSE_PAGE_SHARED_API	Option (System::String name, const System::ArrayPtr< System::SharedPtr< IOptionItem >> &items)
	Creates a new PrintTicket option instance. More...

ASPOSE_PAGE_SHARED_API	Option (const System::ArrayPtr< System::SharedPtr< IOptionItem >> &items)
	Creates a new PrintTicket option instance. More...

ASPOSE_PAGE_SHARED_API	Option (System::SharedPtr< Option > option)
	Creates a clone option instance. More...

ASPOSE_PAGE_SHARED_API void	Add (const System::ArrayPtr< System::SharedPtr< IOptionItem >> &items)
	Adds a list of items to the end of this option's item list. Each one must be a ScoredProperty or Property instance. More...

Public Member Functions inherited from Aspose::Page::XPS::XpsMetadata::CompositePrintTicketElement
ASPOSE_PAGE_SHARED_API	CompositePrintTicketElement (System::String name, const System::ArrayPtr< System::SharedPtr< IPrintTicketElementChild >> &items)
	Creates a new instance. More...

ASPOSE_PAGE_SHARED_API	CompositePrintTicketElement (System::SharedPtr< CompositePrintTicketElement > element)
	Clones this element instance. More...

Public Member Functions inherited from Aspose::Page::XPS::XpsMetadata::PrintTicketElement
ASPOSE_PAGE_SHARED_API System::String	get_Name () override
	Gets the element name. More...

ASPOSE_PAGE_SHARED_API	PrintTicketElement (System::String name)
	Creates a new instance. 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...

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)

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)

Static Public Attributes
static ASPOSE_PAGE_SHARED_API System::SharedPtr< Staple::StapleOption >	SaddleStitch
	Specifies saddle stitch stapling. More...

static ASPOSE_PAGE_SHARED_API System::SharedPtr< Staple::StapleOption >	StapleBottomLeft
	Specifies a single staple in the bottom, left corner. More...

static ASPOSE_PAGE_SHARED_API System::SharedPtr< Staple::StapleOption >	StapleBottomRight
	Specifies a single staple in the bottom, right corner. More...

static ASPOSE_PAGE_SHARED_API System::SharedPtr< Staple::StapleOption >	StapleDualBottom
	Specifies two staples along the bottom edge. More...

static ASPOSE_PAGE_SHARED_API System::SharedPtr< Staple::StapleOption >	StapleDualLeft
	Specifies two staples along the left edge. More...

static ASPOSE_PAGE_SHARED_API System::SharedPtr< Staple::StapleOption >	StapleDualRight
	Specifies two staples along the right edge. More...

static ASPOSE_PAGE_SHARED_API System::SharedPtr< Staple::StapleOption >	StapleDualTop
	Specifies two staples along the top edge More...

static ASPOSE_PAGE_SHARED_API System::SharedPtr< Staple::StapleOption >	None
	Specifies no stapling. More...

static ASPOSE_PAGE_SHARED_API System::SharedPtr< Staple::StapleOption >	StapleTopLeft
	Specifies a single staple in the top, left corner. More...

static ASPOSE_PAGE_SHARED_API System::SharedPtr< Staple::StapleOption >	StapleTopRight
	Specifies a single staple in the top, right corner. More...

Protected Member Functions
ASPOSE_PAGE_SHARED_API System::ArrayPtr< System::String >	get_Names () override

virtual ASPOSE_PAGE_SHARED_API	~StapleOption ()

Protected Member Functions inherited from Aspose::Page::XPS::XpsMetadata::Option
ASPOSE_PAGE_SHARED_API bool	get_UniqueNames () override

	Option (System::SharedPtr< System::Xml::XmlNode > node)

	MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (Option, CODEPORTING_ARGS(System::SharedPtr< System::Xml::XmlNode > node))

ASPOSE_PAGE_SHARED_API System::SharedPtr< System::Xml::XmlNode >	ToXml (System::SharedPtr< System::Xml::XmlDocument > document) override

ASPOSE_PAGE_SHARED_API System::SharedPtr< Option >	MakeConst ()
	Makes this instance constant, i.e. any call to the Add() method will throw an exception. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< PrintTicketElement >	CloneThis () override
	Clones this option element. More...

virtual ASPOSE_PAGE_SHARED_API	~Option ()

Protected Member Functions inherited from Aspose::Page::XPS::XpsMetadata::CompositePrintTicketElement
int32_t	get_Count ()

void	Insert (int32_t index, System::SharedPtr< IPrintTicketElementChild > item)

void	Add (const System::ArrayPtr< System::SharedPtr< IPrintTicketElementChild >> &items)

void	ChildrenToXml (System::SharedPtr< System::Xml::XmlDocument > document, System::SharedPtr< System::Xml::XmlElement > element)

System::SharedPtr< IPrintTicketElementChild >	FindByName (System::String name)

System::SharedPtr< IPrintTicketElementChild >	idx_get (int32_t i)

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

Describes the JobStapleAllDocuments and DocumentStaple features options.

Constructor & Destructor Documentation

◆ StapleOption()

ASPOSE_PAGE_SHARED_API Aspose::Page::XPS::XpsMetadata::Staple::StapleOption::StapleOption	(	System::String	optionName,
		const System::ArrayPtr< System::SharedPtr< Staple::IStapleOptionItem >> &	items
	)

Creates a new instance.

Parameters

optionName	An options name.
items	An arbitrary array of IStapleOptionItem instances.

◆ ~StapleOption()

virtual ASPOSE_PAGE_SHARED_API Aspose::Page::XPS::XpsMetadata::Staple::StapleOption::~StapleOption ( )

protectedvirtual

Member Function Documentation

◆ Add()

ASPOSE_PAGE_SHARED_API System::SharedPtr<Staple::StapleOption> Aspose::Page::XPS::XpsMetadata::Staple::StapleOption::Add ( const System::ArrayPtr< System::SharedPtr< Staple::IStapleOptionItem >> & items )

Adds an array of IStapleOptionItem instances to the feature.

Parameters

items An arbitrary array of IStapleOptionItem instances.

Returns: This options instance.

◆ get_Names()

ASPOSE_PAGE_SHARED_API System::ArrayPtr<System::String> Aspose::Page::XPS::XpsMetadata::Staple::StapleOption::get_Names ( )

overrideprotectedvirtual

Reimplemented from Aspose::Page::XPS::XpsMetadata::CompositePrintTicketElement.

◆ SetAngle()

ASPOSE_PAGE_SHARED_API System::SharedPtr<Staple::StapleOption> Aspose::Page::XPS::XpsMetadata::Staple::StapleOption::SetAngle ( int32_t angle )

Sets an Angle scored property value.

Parameters

angle An Angle scored property value.

Returns: This option instance.

◆ SetSheetCapacity()

ASPOSE_PAGE_SHARED_API System::SharedPtr<Staple::StapleOption> Aspose::Page::XPS::XpsMetadata::Staple::StapleOption::SetSheetCapacity ( int32_t sheetCapacity )

Sets an SheetCapacity scored property value.

Parameters

sheetCapacity An SheetCapacity scored property value.

Returns: This option instance.

Member Data Documentation

◆ None

ASPOSE_PAGE_SHARED_API System::SharedPtr<Staple::StapleOption> Aspose::Page::XPS::XpsMetadata::Staple::StapleOption::None

static

Specifies no stapling.

◆ SaddleStitch

ASPOSE_PAGE_SHARED_API System::SharedPtr<Staple::StapleOption> Aspose::Page::XPS::XpsMetadata::Staple::StapleOption::SaddleStitch

static

Specifies saddle stitch stapling.

◆ StapleBottomLeft

ASPOSE_PAGE_SHARED_API System::SharedPtr<Staple::StapleOption> Aspose::Page::XPS::XpsMetadata::Staple::StapleOption::StapleBottomLeft

static

Specifies a single staple in the bottom, left corner.

◆ StapleBottomRight

ASPOSE_PAGE_SHARED_API System::SharedPtr<Staple::StapleOption> Aspose::Page::XPS::XpsMetadata::Staple::StapleOption::StapleBottomRight

static

Specifies a single staple in the bottom, right corner.

◆ StapleDualBottom

ASPOSE_PAGE_SHARED_API System::SharedPtr<Staple::StapleOption> Aspose::Page::XPS::XpsMetadata::Staple::StapleOption::StapleDualBottom

static

Specifies two staples along the bottom edge.

◆ StapleDualLeft

ASPOSE_PAGE_SHARED_API System::SharedPtr<Staple::StapleOption> Aspose::Page::XPS::XpsMetadata::Staple::StapleOption::StapleDualLeft

static

Specifies two staples along the left edge.

◆ StapleDualRight

ASPOSE_PAGE_SHARED_API System::SharedPtr<Staple::StapleOption> Aspose::Page::XPS::XpsMetadata::Staple::StapleOption::StapleDualRight

static

Specifies two staples along the right edge.

◆ StapleDualTop

ASPOSE_PAGE_SHARED_API System::SharedPtr<Staple::StapleOption> Aspose::Page::XPS::XpsMetadata::Staple::StapleOption::StapleDualTop

static

Specifies two staples along the top edge

◆ StapleTopLeft

ASPOSE_PAGE_SHARED_API System::SharedPtr<Staple::StapleOption> Aspose::Page::XPS::XpsMetadata::Staple::StapleOption::StapleTopLeft

static

Specifies a single staple in the top, left corner.

◆ StapleTopRight

ASPOSE_PAGE_SHARED_API System::SharedPtr<Staple::StapleOption> Aspose::Page::XPS::XpsMetadata::Staple::StapleOption::StapleTopRight

static

Specifies a single staple in the top, right corner.

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ StapleOption()

◆ ~StapleOption()

Member Function Documentation

◆ Add()

◆ get_Names()

◆ SetAngle()

◆ SetSheetCapacity()

Member Data Documentation

◆ None

◆ SaddleStitch

◆ StapleBottomLeft

◆ StapleBottomRight

◆ StapleDualBottom

◆ StapleDualLeft

◆ StapleDualRight

◆ StapleDualTop

◆ StapleTopLeft

◆ StapleTopRight