PrintCustomTextOptionDetails Class

Reference

Definition

Namespace:: Windows.Graphics.Printing.OptionDetails

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Represents a custom print task option.

public ref class PrintCustomTextOptionDetails sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class PrintCustomTextOptionDetails final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class PrintCustomTextOptionDetails

Public NotInheritable Class PrintCustomTextOptionDetails

Inheritance: Object Platform::Object IInspectable PrintCustomTextOptionDetails

Attributes: ContractVersionAttribute MarshalingBehaviorAttribute

Implements: IPrintCustomOptionDetails IPrintOptionDetails

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)

Remarks

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

// This code creates a new custom text option. 
PrintCustomTextOptionDetails 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. 
PrintCustomTextOptionDetails printCustomTextOptionDetails =
    (PrintCustomTextOptionDetails)printDetailedOptions.Options["myCustomText"];

Version history

Windows version	SDK version	Value added
1803	17134	Description
1803	17134	WarningText

Properties

Description	Gets or sets a description of the print custom text option.
DisplayName	Gets or sets the display name of the custom print task option.
ErrorText	Gets or sets the string for an error condition.
MaxCharacters	Gets or sets the maximum number of characters for the display name of the custom print task option.
OptionId	Gets the ID of the custom print task option.
OptionType	Gets the option type for the custom print task option.
State	Gets or sets the state of a custom print task option.
Value	Gets or sets the value of a custom print task option.
WarningText	Gets or sets a string for a warning condition.

Methods

TrySetValue(Object)

Sets the value for the custom print task.

Applies to

Jaa