/
TextModifier.xml
194 lines (187 loc) · 13.1 KB
/
TextModifier.xml
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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
<Type Name="TextModifier" FullName="System.Windows.Media.TextFormatting.TextModifier">
<TypeSignature Language="C#" Value="public abstract class TextModifier : System.Windows.Media.TextFormatting.TextRun" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit TextModifier extends System.Windows.Media.TextFormatting.TextRun" />
<TypeSignature Language="DocId" Value="T:System.Windows.Media.TextFormatting.TextModifier" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class TextModifier
Inherits TextRun" />
<TypeSignature Language="F#" Value="type TextModifier = class
 inherit TextRun" />
<TypeSignature Language="C++ CLI" Value="public ref class TextModifier abstract : System::Windows::Media::TextFormatting::TextRun" />
<AssemblyInfo>
<AssemblyName>PresentationCore</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>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Windows.Media.TextFormatting.TextRun</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Represents a specialized text run that can be used to modify properties of text runs within its scope.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The scope of the <xref:System.Windows.Media.TextFormatting.TextModifier> extends to the next matching <xref:System.Windows.Media.TextFormatting.TextEndOfSegment> text run, or to the next <xref:System.Windows.Media.TextFormatting.TextEndOfParagraph>. Note that <xref:System.Windows.Media.TextFormatting.TextModifier> objects can be nested.
]]></format>
</remarks>
<related type="ExternalDocumentation" href="https://go.microsoft.com/fwlink/?LinkID=159965">Advanced Text Formatting Sample</related>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected TextModifier ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.TextFormatting.TextModifier.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberSignature Language="C++ CLI" Value="protected:
 TextModifier();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</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>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Windows.Media.TextFormatting.TextModifier" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CharacterBufferReference">
<MemberSignature Language="C#" Value="public override sealed System.Windows.Media.TextFormatting.CharacterBufferReference CharacterBufferReference { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Windows.Media.TextFormatting.CharacterBufferReference CharacterBufferReference" />
<MemberSignature Language="DocId" Value="P:System.Windows.Media.TextFormatting.TextModifier.CharacterBufferReference" />
<MemberSignature Language="VB.NET" Value="Public Overrides NotOverridable ReadOnly Property CharacterBufferReference As CharacterBufferReference" />
<MemberSignature Language="F#" Value="member this.CharacterBufferReference : System.Windows.Media.TextFormatting.CharacterBufferReference" Usage="System.Windows.Media.TextFormatting.TextModifier.CharacterBufferReference" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Windows::Media::TextFormatting::CharacterBufferReference CharacterBufferReference { System::Windows::Media::TextFormatting::CharacterBufferReference get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</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>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Windows.Media.TextFormatting.CharacterBufferReference</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the <see cref="T:System.Windows.Media.TextFormatting.CharacterBufferReference" /> for the <see cref="T:System.Windows.Media.TextFormatting.TextModifier" />.</summary>
<value>A value of type <see cref="T:System.Windows.Media.TextFormatting.CharacterBufferReference" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="FlowDirection">
<MemberSignature Language="C#" Value="public abstract System.Windows.FlowDirection FlowDirection { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Windows.FlowDirection FlowDirection" />
<MemberSignature Language="DocId" Value="P:System.Windows.Media.TextFormatting.TextModifier.FlowDirection" />
<MemberSignature Language="VB.NET" Value="Public MustOverride ReadOnly Property FlowDirection As FlowDirection" />
<MemberSignature Language="F#" Value="member this.FlowDirection : System.Windows.FlowDirection" Usage="System.Windows.Media.TextFormatting.TextModifier.FlowDirection" />
<MemberSignature Language="C++ CLI" Value="public:
 abstract property System::Windows::FlowDirection FlowDirection { System::Windows::FlowDirection get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</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>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Windows.FlowDirection</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the <see cref="T:System.Windows.FlowDirection" /> for the <see cref="T:System.Windows.Media.TextFormatting.TextModifier" />.</summary>
<value>A value of type <see cref="T:System.Windows.FlowDirection" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
<xref:System.Windows.FlowDirection> specifies the direction of content flow for text and user interface (UI) elements, and can be either <xref:System.Windows.FlowDirection.LeftToRight> or <xref:System.Windows.FlowDirection.RightToLeft>.
This value is ignored unless the <xref:System.Windows.Media.TextFormatting.TextModifier.HasDirectionalEmbedding%2A> property returns `true`.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="HasDirectionalEmbedding">
<MemberSignature Language="C#" Value="public abstract bool HasDirectionalEmbedding { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool HasDirectionalEmbedding" />
<MemberSignature Language="DocId" Value="P:System.Windows.Media.TextFormatting.TextModifier.HasDirectionalEmbedding" />
<MemberSignature Language="VB.NET" Value="Public MustOverride ReadOnly Property HasDirectionalEmbedding As Boolean" />
<MemberSignature Language="F#" Value="member this.HasDirectionalEmbedding : bool" Usage="System.Windows.Media.TextFormatting.TextModifier.HasDirectionalEmbedding" />
<MemberSignature Language="C++ CLI" Value="public:
 abstract property bool HasDirectionalEmbedding { bool get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</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>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value that indicates whether the <see cref="T:System.Windows.Media.TextFormatting.TextModifier" /> supports <see cref="T:System.Windows.FlowDirection" /> for the current scope of text.</summary>
<value>
<see langword="true" /> if <see cref="T:System.Windows.Media.TextFormatting.TextModifier" /> supports <see cref="T:System.Windows.FlowDirection" /> for the current scope of text; otherwise, <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
When the return value is `true`, <xref:System.Windows.Media.TextFormatting.TextFormatter> uses the <xref:System.Windows.Media.TextFormatting.TextModifier.FlowDirection%2A> property to determine the direction of content flow for the current scope of text.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ModifyProperties">
<MemberSignature Language="C#" Value="public abstract System.Windows.Media.TextFormatting.TextRunProperties ModifyProperties (System.Windows.Media.TextFormatting.TextRunProperties properties);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Windows.Media.TextFormatting.TextRunProperties ModifyProperties(class System.Windows.Media.TextFormatting.TextRunProperties properties) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.TextFormatting.TextModifier.ModifyProperties(System.Windows.Media.TextFormatting.TextRunProperties)" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function ModifyProperties (properties As TextRunProperties) As TextRunProperties" />
<MemberSignature Language="F#" Value="abstract member ModifyProperties : System.Windows.Media.TextFormatting.TextRunProperties -> System.Windows.Media.TextFormatting.TextRunProperties" Usage="textModifier.ModifyProperties properties" />
<MemberSignature Language="C++ CLI" Value="public:
 abstract System::Windows::Media::TextFormatting::TextRunProperties ^ ModifyProperties(System::Windows::Media::TextFormatting::TextRunProperties ^ properties);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</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>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Windows.Media.TextFormatting.TextRunProperties</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="properties" Type="System.Windows.Media.TextFormatting.TextRunProperties" />
</Parameters>
<Docs>
<param name="properties">The <see cref="T:System.Windows.Media.TextFormatting.TextRunProperties" /> for a text run, or the return value of <see cref="M:System.Windows.Media.TextFormatting.TextModifier.ModifyProperties(System.Windows.Media.TextFormatting.TextRunProperties)" /> for a nested text modifier.</param>
<summary>Retrieves the <see cref="T:System.Windows.Media.TextFormatting.TextRunProperties" /> for a text run.</summary>
<returns>The actual <see cref="T:System.Windows.Media.TextFormatting.TextRunProperties" /> to be used by the <see cref="T:System.Windows.Media.TextFormatting.TextFormatter" />, subject to further modification by <see cref="T:System.Windows.Media.TextFormatting.TextModifier" /> objects at outer scopes.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>