PrintCustomTextOptionDetails PrintCustomTextOptionDetails PrintCustomTextOptionDetails PrintCustomTextOptionDetails PrintCustomTextOptionDetails Class

Definition

Represents a custom print task option.

public : sealed class PrintCustomTextOptionDetails : IPrintCustomOptionDetails, IPrintCustomTextOptionDetails, IPrintOptionDetails
struct winrt::Windows::Graphics::Printing::OptionDetails::PrintCustomTextOptionDetails : IPrintCustomOptionDetails, IPrintCustomTextOptionDetails, IPrintOptionDetails
public sealed class PrintCustomTextOptionDetails : IPrintCustomOptionDetails, IPrintCustomTextOptionDetails, IPrintOptionDetails
Public NotInheritable Class PrintCustomTextOptionDetails Implements IPrintCustomOptionDetails, IPrintCustomTextOptionDetails, IPrintOptionDetails
// This class does not provide a public constructor.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

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");

Properties

Description Description Description Description Description

Gets or sets a description of the print custom text option.

DisplayName DisplayName DisplayName DisplayName DisplayName

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

ErrorText ErrorText ErrorText ErrorText ErrorText

Gets or sets the string for an error condition.

MaxCharacters MaxCharacters MaxCharacters MaxCharacters MaxCharacters

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

OptionId OptionId OptionId OptionId OptionId

Gets the ID of the custom print task option.

OptionType OptionType OptionType OptionType OptionType

Gets the option type for the custom print task option.

State State State State State

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

Value Value Value Value Value

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

WarningText WarningText WarningText WarningText WarningText

Gets or sets a string for a warning condition.

Methods

TrySetValue(Object) TrySetValue(Object) TrySetValue(Object) TrySetValue(Object) TrySetValue(Object)

Sets the value for the custom print task.