Important Property Instances
This topic is not current. For the most current information, see the Print Schema Specification.
In order for a PrintCapabilities client to be able to construct a reasonable PrintTicket, the PrintCapabilities document must provide certain properties of Feature instances as well as Option instances within the Feature. A generic user interface (UI) module requires such information to construct a UI. This in turn requires that the Print Schema Keywords define a few Property instances that appear as children of Feature and Option elements.
Feature elements can contain the following Property.
Property | Values | Purpose |
---|---|---|
SelectionType |
PickOne PickMany |
Specifies the number of Options that can be selected for this Feature at a given time, either one (PickOne), or more than one (PickMany). The client can use this information to construct a PrintTicket. This information affects UI behavior, as well as PrintTicket validation by the provider. |
Option elements can contain the following Property.
Property | Values | Purpose |
---|---|---|
IdentityOption |
True False |
Selecting the IdentityOption Property is interpreted to mean "disable this feature". A Feature that contains a SelectionType Property whose value is PickMany must also contain an Option that has an IdentityOption Property. The UI code (or client constructing a PrintTicket) must deselect any other Option if the IdentityOption Property is selected. |
Feature, Option, and ParameterDef elements can contain the following Property.
Property | Values | Purpose |
---|---|---|
DisplayUI |
Show Hide |
Specifies whether the parent element should be displayed in the UI. Show indicates that the element should be displayed in the UI. Hide indicates that the element should not be displayed in the UI. If this Property is not defined for an element, the default interpretation is Show, meaning that the element is displayed. |
Feature, Option, and ParameterDef elements can contain the following Property.
Property | Value | Purpose |
---|---|---|
DisplayName |
String |
Specifies the display string for the parent element, overriding the default display name. Can be used by PrintCapabilities providers to present a localized and user friendly display name. The default display name value is the name attribute for the parent element. In the case of Option elements, if the name attribute is not provided, then the DisplayName Property must be present. |
Related topics
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for