PrintCustomTextOptionDetails class

PrintCustomTextOptionDetails class

Represents a custom print task option.

Syntax


/* For information about creating or accessing this object, see Remarks. */

Members

The PrintCustomTextOptionDetails class has these types of members:

Methods

The PrintCustomTextOptionDetails class has these methods. With C#, Visual Basic, and C++, it also inherits methods from the Object class.

MethodDescription
TrySetValue Sets the value for the custom print task.

 

Properties

The PrintCustomTextOptionDetails class has these properties.

PropertyAccess typeDescription

DisplayName

Read/write

Gets or sets the display name of the custom print task option.

ErrorText

Read/write

Gets or sets the string for an error condition.

MaxCharacters

Read/write

Gets or sets the maximum number of characters for the display name of the custom print task option.

OptionId

Read-only

Gets the ID of the custom print task option.

OptionType

Read-only

Gets the option type for the custom print task option.

State

Read/write

Gets or sets the state of a custom print task option.

Value

Read-only

Gets or sets the value of a custom print task option.

 

Remarks

Here is a JavaScript code snippet that shows how to retrieve the object:


// This code creates a new custom text option and returns a 
// customTextOption is an object of type: PrintCustomTextOptionDetails 
var customTextOption =
      printDetailedOptions.createTextOption("myCustomText", "Custom Options");

// later in your app, when you want to access the custom text option created above,
// but you don’t have access to the customTextOption variable that was returned 
// when it was created, you can get it by looking up the same optionId that 
// you used to create it. 
var printCustomTextOptionDetails =
      printDetailedOptions.options.lookup("myCustomText");


Requirements (Windows 10 device family)

Device family

Universal, introduced version 10.0.10240.0 [for Xbox, see UWP features that aren't yet supported on Xbox]

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

Windows.Graphics.Printing.OptionDetails
Windows::Graphics::Printing::OptionDetails [C++]

Metadata

Windows.Foundation.UniversalApiContract.winmd

Requirements (Windows 8.x and Windows Phone 8.x)

Minimum supported client

Windows 8 [Windows Store apps only]

Minimum supported server

Windows Server 2012 [Windows Store apps only]

Minimum supported phone

None supported

Namespace

Windows.Graphics.Printing.OptionDetails
Windows::Graphics::Printing::OptionDetails [C++]

Metadata

Windows.winmd

Attributes

[MarshalingBehavior(Agile)]
[Version(0x06020000)]

See also

Object
IPrintOptionDetails
IPrintCustomOptionDetails

 

 

Show:
© 2016 Microsoft