Aspose::Page::XPS::XpsMetadata::Option Class Reference

The class that implements a common PrintTicket

Option

. The base class for all schema-defined options. An Option element contains all of the Property and ScoredProperty elements associated with this option. https://docs.microsoft.com/en-us/windows/win32/printdocs/option More...

Inherits Aspose::Page::XPS::XpsMetadata::CompositePrintTicketElement, and Aspose::Page::XPS::XpsMetadata::IFeatureItem.

Inherited by Aspose::Page::XPS::XpsMetadata::Collate::CollateOption, Aspose::Page::XPS::XpsMetadata::DocumentBannerSheet::BannerSheetOption, Aspose::Page::XPS::XpsMetadata::DocumentBinding::BindingOption, Aspose::Page::XPS::XpsMetadata::DocumentCoverBack::CoverBackOption, Aspose::Page::XPS::XpsMetadata::DocumentCoverFront::CoverFrontOption, Aspose::Page::XPS::XpsMetadata::DocumentSeparatorSheet::DocumentSeparatorSheetOption, Aspose::Page::XPS::XpsMetadata::Duplex::DuplexOption, Aspose::Page::XPS::XpsMetadata::HolePunch::HolePunchOption, Aspose::Page::XPS::XpsMetadata::InputBin::InputBinOption, Aspose::Page::XPS::XpsMetadata::JobAccountingSheet::JobAccountingSheetOption, Aspose::Page::XPS::XpsMetadata::JobBindAllDocuments::BindingOption, Aspose::Page::XPS::XpsMetadata::JobDeviceLanguage::JobDeviceLanguageOption, Aspose::Page::XPS::XpsMetadata::JobDigitalSignatureProcessing::JobDigitalSignatureProcessingOption, Aspose::Page::XPS::XpsMetadata::JobErrorSheet::ErrorSheetOption, Aspose::Page::XPS::XpsMetadata::JobErrorSheet::ErrorSheetWhen::ErrorSheetWhenOption, Aspose::Page::XPS::XpsMetadata::JobOutputOptimization::JobOutputOptimizationOption, Aspose::Page::XPS::XpsMetadata::JobPageOrder::JobPageOrderOption, Aspose::Page::XPS::XpsMetadata::JobPrimaryBannerSheet::BannerSheetOption, Aspose::Page::XPS::XpsMetadata::JobPrimaryCoverBack::CoverBackOption, Aspose::Page::XPS::XpsMetadata::JobPrimaryCoverFront::CoverFrontOption, Aspose::Page::XPS::XpsMetadata::NUp::PresentationDirection::PresentationDirectionOption, Aspose::Page::XPS::XpsMetadata::OutputBin::OutputBinOption, Aspose::Page::XPS::XpsMetadata::PageBlackGenerationProcessing::PageBlackGenerationProcessingOption, Aspose::Page::XPS::XpsMetadata::PageBlendColorSpace::PageBlendColorSpaceOption, Aspose::Page::XPS::XpsMetadata::PageBorderless::PageBorderlessOption, Aspose::Page::XPS::XpsMetadata::PageColorManagement::PageColorManagementOption, Aspose::Page::XPS::XpsMetadata::PageDestinationColorProfile::PageDestinationColorProfileOption, Aspose::Page::XPS::XpsMetadata::PageDeviceColorSpaceUsage::PageDeviceColorSpaceUsageOption, Aspose::Page::XPS::XpsMetadata::PageDeviceFontSubstitution::PageDeviceFontSubstitutionOption, Aspose::Page::XPS::XpsMetadata::PageForceFrontSide::PageForceFrontSideOption, Aspose::Page::XPS::XpsMetadata::PageICMRenderingIntent::PageICMRenderingIntentOption, Aspose::Page::XPS::XpsMetadata::PageMediaColor::PageMediaColorOption, Aspose::Page::XPS::XpsMetadata::PageMediaSize::PageMediaSizeOption, Aspose::Page::XPS::XpsMetadata::PageMediaType::PageMediaTypeOption, Aspose::Page::XPS::XpsMetadata::PageMirrorImage::PageMirrorImageOption, Aspose::Page::XPS::XpsMetadata::PageNegativeImage::PageNegativeImageOption, Aspose::Page::XPS::XpsMetadata::PageOrientation::PageOrientationOption, Aspose::Page::XPS::XpsMetadata::PageOutputColor::PageOutputColorOption, Aspose::Page::XPS::XpsMetadata::PageOutputQuality::PageOutputQualityOption, Aspose::Page::XPS::XpsMetadata::PagePhotoPrintingIntent::PagePhotoPrintingIntentOption, Aspose::Page::XPS::XpsMetadata::PageResolution::PageResolutionOption, Aspose::Page::XPS::XpsMetadata::PageScaling::PageScalingOption, Aspose::Page::XPS::XpsMetadata::PageScaling::ScaleOffsetAlignmentOption, Aspose::Page::XPS::XpsMetadata::PageSourceColorProfile::PageSourceColorProfileOption, Aspose::Page::XPS::XpsMetadata::PageTrueTypeFontMode::PageTrueTypeFontModeOption, Aspose::Page::XPS::XpsMetadata::PageWatermark::LayeringOption, Aspose::Page::XPS::XpsMetadata::PageWatermark::PageWatermarkOption, Aspose::Page::XPS::XpsMetadata::RollCut::RollCutOption, and Aspose::Page::XPS::XpsMetadata::Staple::StapleOption.

Public Member Functions
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)

Protected Member Functions
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
virtual ASPOSE_PAGE_SHARED_API System::ArrayPtr< System::String >	get_Names ()
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 >	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

The class that implements a common PrintTicket

Option

. The base class for all schema-defined options. An Option element contains all of the Property and ScoredProperty elements associated with this option. https://docs.microsoft.com/en-us/windows/win32/printdocs/option

Constructor & Destructor Documentation

Option() [1/4]

ASPOSE_PAGE_SHARED_API Aspose::Page::XPS::XpsMetadata::Option::Option	(	System::String	name,
		const System::ArrayPtr< System::SharedPtr< IOptionItem >> &	items
	)

Creates a new PrintTicket option instance.

Parameters

name	An arbitrary option name.
items	An arbitrary array of IOptionItem instances. Each one must be a ScoredProperty or a Property instance.

Option() [2/4]

ASPOSE_PAGE_SHARED_API Aspose::Page::XPS::XpsMetadata::Option::Option

(

const System::ArrayPtr< System::SharedPtr< IOptionItem >> &

items

)

Creates a new PrintTicket option instance.

Parameters

items

An arbitrary array of IOptionItem instances. Each one must be a ScoredProperty or a Property instance.

Option() [3/4]

ASPOSE_PAGE_SHARED_API Aspose::Page::XPS::XpsMetadata::Option::Option

(

System::SharedPtr< Option >

option

)

Creates a clone option instance.

Parameters

option

An option instance to clone.

Option() [4/4]

Aspose::Page::XPS::XpsMetadata::Option::Option ( System::SharedPtr< System::Xml::XmlNode >  node )

protected

~Option()

virtual ASPOSE_PAGE_SHARED_API Aspose::Page::XPS::XpsMetadata::Option::~Option ( )

protectedvirtual

Member Function Documentation

Add()

ASPOSE_PAGE_SHARED_API void Aspose::Page::XPS::XpsMetadata::Option::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.

Parameters

items

List of items to add.

CloneThis()

ASPOSE_PAGE_SHARED_API System::SharedPtr<PrintTicketElement> Aspose::Page::XPS::XpsMetadata::Option::CloneThis ( )

overrideprotectedvirtual

Clones this option element.

Returns

The clone of this option element.

Implements Aspose::Page::XPS::XpsMetadata::PrintTicketElement.

get_UniqueNames()

ASPOSE_PAGE_SHARED_API bool Aspose::Page::XPS::XpsMetadata::Option::get_UniqueNames ( )

overrideprotectedvirtual

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

MakeConst()

ASPOSE_PAGE_SHARED_API System::SharedPtr<Option> Aspose::Page::XPS::XpsMetadata::Option::MakeConst ( )

protected

Makes this instance constant, i.e. any call to the Add() method will throw an exception.

Returns

This option.

MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION()

Aspose::Page::XPS::XpsMetadata::Option::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION ( Option  , CODEPORTING_ARGS(System::SharedPtr< System::Xml::XmlNode > node)    )

protected

ToXml()

ASPOSE_PAGE_SHARED_API System::SharedPtr<System::Xml::XmlNode> Aspose::Page::XPS::XpsMetadata::Option::ToXml ( System::SharedPtr< System::Xml::XmlDocument >  document )

overrideprotectedvirtual

Implements Aspose::Page::XPS::XpsMetadata::PrintTicketElement.