dotnet-api-docs/xml/System.Printing/DeviceFontSubstitution.xml at 394b6acbd8c0d0d8c2cf20198c8139937d83b8c0 · dotnet/dotnet-api-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
<Type Name="DeviceFontSubstitution" FullName="System.Printing.DeviceFontSubstitution">
  <TypeSignature Language="C#" Value="public enum DeviceFontSubstitution" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed DeviceFontSubstitution extends System.Enum" />
  <TypeSignature Language="DocId" Value="T:System.Printing.DeviceFontSubstitution" />
  <TypeSignature Language="VB.NET" Value="Public Enum DeviceFontSubstitution" />
  <TypeSignature Language="F#" Value="type DeviceFontSubstitution = " />
  <TypeSignature Language="C++ CLI" Value="public enum class DeviceFontSubstitution" />
  <AssemblyInfo>
    <AssemblyName>ReachFramework</AssemblyName>
    <AssemblyVersion>3.0.0.0</AssemblyVersion>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
    <AssemblyVersion>5.0.0.0</AssemblyVersion>
    <AssemblyVersion>6.0.0.0</AssemblyVersion>
    <AssemblyVersion>7.0.0.0</AssemblyVersion>
    <AssemblyVersion>8.0.0.0</AssemblyVersion>
    <AssemblyVersion>9.0.0.0</AssemblyVersion>
    <AssemblyVersion>10.0.0.0</AssemblyVersion>
    <AssemblyVersion>11.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Enum</BaseTypeName>
  </Base>
  <Docs>
    <summary>Specifies whether device font substitution is enabled on a printer.</summary>
    <remarks>
      <format type="text/markdown"><![CDATA[

## Remarks
 Printing is faster when only the text, not the font, is sent to the printer. Some printers have fonts that are permanently stored in their memory. These printers enable users to substitute a resident printer font for each font that is used by the printing application.

 The values of this type are used primarily for these purposes:

- As members of the <xref:System.Printing.PrintCapabilities.DeviceFontSubstitutionCapability*> collection, a property of <xref:System.Printing.PrintCapabilities>, they represent the printer capabilities.

- As the value of the <xref:System.Printing.PrintTicket.DeviceFontSubstitution> property of a <xref:System.Printing.PrintTicket>, they instruct the printer to enable or disable device font substitution for the print job.

 The Unknown value is never used in properties of <xref:System.Printing.PrintCapabilities> objects.

 You should never set a <xref:System.Printing.PrintTicket> property to Unknown. If some other <xref:System.Printing.PrintTicket> producing application has created a PrintTicket document that sets the device font substitution feature to an unrecognized option (that is, an option that is not defined in the [Print Schema](https://go.microsoft.com/fwlink/?LinkId=186397)), then a <xref:System.Printing.PrintTicket> object in your application that is constructed with that document will have Unknown as the value of the <xref:System.Printing.PrintTicket.DeviceFontSubstitution> property.

 Although the <xref:System.Printing.PrintTicket> and <xref:System.Printing.PrintCapabilities> classes cannot be inherited, you can extend the [Print Schema](https://go.microsoft.com/fwlink/?LinkId=186397) to recognize print device features that are not accounted for in the <xref:System.Printing.PrintTicket> or <xref:System.Printing.PrintCapabilities> classes. For more information, see [How to: Extend the Print Schema and Create New Print System Classes](https://learn.microsoft.com/previous-versions/aa970573(v=vs.100)).


## Examples
 The following example shows how to determine printer capabilities and configure the print job to take advantage of them.

 :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/XpsCreate/CPP/XpsCreate.cpp" id="Snippetprintercapabilities":::
 :::code language="csharp" source="~/snippets/csharp/System.Printing/Collation/Overview/XpsCreate.cs" id="Snippetprintercapabilities":::
 :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/XpsCreate/visualbasic/xpscreate.vb" id="Snippetprintercapabilities":::

 ]]></format>
    </remarks>
    <altmember cref="T:System.Printing.PrintCapabilities" />
    <altmember cref="T:System.Printing.PrintTicket" />
  </Docs>
  <Members>
    <Member MemberName="Off">
      <MemberSignature Language="C#" Value="Off" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Printing.DeviceFontSubstitution Off = int32(1)" />
      <MemberSignature Language="DocId" Value="F:System.Printing.DeviceFontSubstitution.Off" />
      <MemberSignature Language="VB.NET" Value="Off" />
      <MemberSignature Language="F#" Value="Off = 1" Usage="System.Printing.DeviceFontSubstitution.Off" />
      <MemberSignature Language="C++ CLI" Value="Off" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>ReachFramework</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
        <AssemblyVersion>11.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Printing.DeviceFontSubstitution</ReturnType>
      </ReturnValue>
      <MemberValue>1</MemberValue>
      <Docs>
        <summary>Device font substitution is disabled.</summary>
      </Docs>
    </Member>
    <Member MemberName="On">
      <MemberSignature Language="C#" Value="On" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Printing.DeviceFontSubstitution On = int32(2)" />
      <MemberSignature Language="DocId" Value="F:System.Printing.DeviceFontSubstitution.On" />
      <MemberSignature Language="VB.NET" Value="On" />
      <MemberSignature Language="F#" Value="On = 2" Usage="System.Printing.DeviceFontSubstitution.On" />
      <MemberSignature Language="C++ CLI" Value="On" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>ReachFramework</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
        <AssemblyVersion>11.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Printing.DeviceFontSubstitution</ReturnType>
      </ReturnValue>
      <MemberValue>2</MemberValue>
      <Docs>
        <summary>Device font substitution is enabled.</summary>
      </Docs>
    </Member>
    <Member MemberName="Unknown">
      <MemberSignature Language="C#" Value="Unknown" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Printing.DeviceFontSubstitution Unknown = int32(0)" />
      <MemberSignature Language="DocId" Value="F:System.Printing.DeviceFontSubstitution.Unknown" />
      <MemberSignature Language="VB.NET" Value="Unknown" />
      <MemberSignature Language="F#" Value="Unknown = 0" Usage="System.Printing.DeviceFontSubstitution.Unknown" />
      <MemberSignature Language="C++ CLI" Value="Unknown" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>ReachFramework</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
        <AssemblyVersion>11.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Printing.DeviceFontSubstitution</ReturnType>
      </ReturnValue>
      <MemberValue>0</MemberValue>
      <Docs>
        <summary>The feature (whose options are represented by this enumeration) is set to an option not defined in the <see href="https://learn.microsoft.com/windows/desktop/printdocs/printschema">Print Schema</see>.</summary>
      </Docs>
    </Member>
  </Members>
</Type>