Rename Managed.Windows.Forms to System.Windows.Forms for consistency.
[mono.git] / mcs / class / System.Windows.Forms / Documentation / en / System.Windows.Forms / TextFormatFlags.xml
1 <?xml version="1.0" encoding="utf-8"?>
2 <Type Name="TextFormatFlags" FullName="System.Windows.Forms.TextFormatFlags">
3   <TypeSignature Language="C#" Value="public enum TextFormatFlags" />
4   <AssemblyInfo>
5     <AssemblyName>System.Windows.Forms</AssemblyName>
6     <AssemblyVersion>2.0.0.0</AssemblyVersion>
7   </AssemblyInfo>
8   <Base>
9     <BaseTypeName>System.Enum</BaseTypeName>
10   </Base>
11   <Attributes>
12     <Attribute>
13       <AttributeName>System.Flags</AttributeName>
14     </Attribute>
15   </Attributes>
16   <Docs>
17     <since version=".NET 2.0" />
18     <remarks>
19       <attribution license="cc4" from="Microsoft" modified="false" />
20       <para>The <see cref="T:System.Windows.Forms.TextFormatFlags" /> enumeration is used by the <see cref="T:System.Windows.Forms.TextRenderer" /> when drawing and measuring text. The <see cref="T:System.Windows.Forms.TextRenderer" /> does not support adding tab stops to drawn text, although you can expand existing tab stops using the <see cref="F:System.Windows.Forms.TextFormatFlags.ExpandTabs" /> flag.</para>
21     </remarks>
22     <summary>
23       <attribution license="cc4" from="Microsoft" modified="false" />
24       <para>Specifies the display and layout information for text strings.</para>
25     </summary>
26   </Docs>
27   <Members>
28     <Member MemberName="Bottom">
29       <MemberSignature Language="C#" Value="Bottom" />
30       <MemberType>Field</MemberType>
31       <ReturnValue>
32         <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
33       </ReturnValue>
34       <Docs>
35         <since version=".NET 2.0" />
36         <summary>
37           <attribution license="cc4" from="Microsoft" modified="false" />
38           <para>Aligns the text on the bottom of the bounding rectangle. Applied only when the text is a single line.</para>
39         </summary>
40       </Docs>
41       <AssemblyInfo>
42         <AssemblyVersion>2.0.0.0</AssemblyVersion>
43       </AssemblyInfo>
44     </Member>
45     <Member MemberName="Default">
46       <MemberSignature Language="C#" Value="Default" />
47       <MemberType>Field</MemberType>
48       <ReturnValue>
49         <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
50       </ReturnValue>
51       <Docs>
52         <since version=".NET 2.0" />
53         <summary>
54           <attribution license="cc4" from="Microsoft" modified="false" />
55           <para>Applies the default formatting, which is left-aligned.</para>
56         </summary>
57       </Docs>
58       <AssemblyInfo>
59         <AssemblyVersion>2.0.0.0</AssemblyVersion>
60       </AssemblyInfo>
61     </Member>
62     <Member MemberName="EndEllipsis">
63       <MemberSignature Language="C#" Value="EndEllipsis" />
64       <MemberType>Field</MemberType>
65       <ReturnValue>
66         <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
67       </ReturnValue>
68       <Docs>
69         <since version=".NET 2.0" />
70         <summary>
71           <attribution license="cc4" from="Microsoft" modified="false" />
72           <para>Removes the end of trimmed lines, and replaces them with an ellipsis.</para>
73         </summary>
74       </Docs>
75       <AssemblyInfo>
76         <AssemblyVersion>2.0.0.0</AssemblyVersion>
77       </AssemblyInfo>
78     </Member>
79     <Member MemberName="ExpandTabs">
80       <MemberSignature Language="C#" Value="ExpandTabs" />
81       <MemberType>Field</MemberType>
82       <ReturnValue>
83         <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
84       </ReturnValue>
85       <Docs>
86         <since version=".NET 2.0" />
87         <summary>
88           <attribution license="cc4" from="Microsoft" modified="false" />
89           <para>Expands tab characters. The default number of characters per tab is eight. The <see cref="F:System.Windows.Forms.TextFormatFlags.WordEllipsis" />, <see cref="F:System.Windows.Forms.TextFormatFlags.PathEllipsis" />, and <see cref="F:System.Windows.Forms.TextFormatFlags.EndEllipsis" /> values cannot be used with <see cref="F:System.Windows.Forms.TextFormatFlags.ExpandTabs" />.</para>
90         </summary>
91       </Docs>
92       <AssemblyInfo>
93         <AssemblyVersion>2.0.0.0</AssemblyVersion>
94       </AssemblyInfo>
95     </Member>
96     <Member MemberName="ExternalLeading">
97       <MemberSignature Language="C#" Value="ExternalLeading" />
98       <MemberType>Field</MemberType>
99       <ReturnValue>
100         <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
101       </ReturnValue>
102       <Docs>
103         <since version=".NET 2.0" />
104         <summary>
105           <attribution license="cc4" from="Microsoft" modified="false" />
106           <para>Includes the font external leading in line height. Typically, external leading is not included in the height of a line of text.</para>
107         </summary>
108       </Docs>
109       <AssemblyInfo>
110         <AssemblyVersion>2.0.0.0</AssemblyVersion>
111       </AssemblyInfo>
112     </Member>
113     <Member MemberName="GlyphOverhangPadding">
114       <MemberSignature Language="C#" Value="GlyphOverhangPadding" />
115       <MemberType>Field</MemberType>
116       <ReturnValue>
117         <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
118       </ReturnValue>
119       <Docs>
120         <since version=".NET 2.0" />
121         <summary>
122           <attribution license="cc4" from="Microsoft" modified="false" />
123           <para>Adds padding to the bounding rectangle to accommodate overhanging glyphs. </para>
124         </summary>
125       </Docs>
126       <AssemblyInfo>
127         <AssemblyVersion>2.0.0.0</AssemblyVersion>
128       </AssemblyInfo>
129     </Member>
130     <Member MemberName="HidePrefix">
131       <MemberSignature Language="C#" Value="HidePrefix" />
132       <MemberType>Field</MemberType>
133       <ReturnValue>
134         <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
135       </ReturnValue>
136       <Docs>
137         <since version=".NET 2.0" />
138         <remarks>
139           <attribution license="cc4" from="Microsoft" modified="false" />
140           <para>Ignores the ampersand (&amp;) prefix character in the text. The letter that follows will not be underlined, but other mnemonic-prefix characters are still processed. For example, an input string of "A&amp;bc&amp;&amp;d" with <see cref="F:System.Windows.Forms.TextFormatFlags.HidePrefix" /> applied would result in output of "Abc&amp;d".</para>
141           <para>Compare with <see cref="F:System.Windows.Forms.TextFormatFlags.NoPrefix" /> and <see cref="F:System.Windows.Forms.TextFormatFlags.PrefixOnly" />.</para>
142         </remarks>
143         <summary>
144           <attribution license="cc4" from="Microsoft" modified="false" />
145           <para>Applies to Windows 2000 and Windows XP only: </para>
146         </summary>
147       </Docs>
148       <AssemblyInfo>
149         <AssemblyVersion>2.0.0.0</AssemblyVersion>
150       </AssemblyInfo>
151     </Member>
152     <Member MemberName="HorizontalCenter">
153       <MemberSignature Language="C#" Value="HorizontalCenter" />
154       <MemberType>Field</MemberType>
155       <ReturnValue>
156         <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
157       </ReturnValue>
158       <Docs>
159         <since version=".NET 2.0" />
160         <summary>
161           <attribution license="cc4" from="Microsoft" modified="false" />
162           <para>Centers the text horizontally within the bounding rectangle.</para>
163         </summary>
164       </Docs>
165       <AssemblyInfo>
166         <AssemblyVersion>2.0.0.0</AssemblyVersion>
167       </AssemblyInfo>
168     </Member>
169     <Member MemberName="Internal">
170       <MemberSignature Language="C#" Value="Internal" />
171       <MemberType>Field</MemberType>
172       <ReturnValue>
173         <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
174       </ReturnValue>
175       <Docs>
176         <since version=".NET 2.0" />
177         <summary>
178           <attribution license="cc4" from="Microsoft" modified="false" />
179           <para>Uses the system font to calculate text metrics.</para>
180         </summary>
181       </Docs>
182       <AssemblyInfo>
183         <AssemblyVersion>2.0.0.0</AssemblyVersion>
184       </AssemblyInfo>
185     </Member>
186     <Member MemberName="Left">
187       <MemberSignature Language="C#" Value="Left" />
188       <MemberType>Field</MemberType>
189       <ReturnValue>
190         <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
191       </ReturnValue>
192       <Docs>
193         <since version=".NET 2.0" />
194         <summary>
195           <attribution license="cc4" from="Microsoft" modified="false" />
196           <para>Aligns the text on the left side of the clipping area.</para>
197         </summary>
198       </Docs>
199       <AssemblyInfo>
200         <AssemblyVersion>2.0.0.0</AssemblyVersion>
201       </AssemblyInfo>
202     </Member>
203     <Member MemberName="LeftAndRightPadding">
204       <MemberSignature Language="C#" Value="LeftAndRightPadding" />
205       <MemberType>Field</MemberType>
206       <ReturnValue>
207         <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
208       </ReturnValue>
209       <Docs>
210         <since version=".NET 2.0" />
211         <summary>
212           <attribution license="cc4" from="Microsoft" modified="false" />
213           <para>Adds padding to both sides of the bounding rectangle.</para>
214         </summary>
215       </Docs>
216       <AssemblyInfo>
217         <AssemblyVersion>2.0.0.0</AssemblyVersion>
218       </AssemblyInfo>
219     </Member>
220     <Member MemberName="ModifyString">
221       <MemberSignature Language="C#" Value="ModifyString" />
222       <MemberType>Field</MemberType>
223       <ReturnValue>
224         <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
225       </ReturnValue>
226       <Docs>
227         <since version=".NET 2.0" />
228         <summary>
229           <attribution license="cc4" from="Microsoft" modified="false" />
230           <para>Has no effect on the drawn text.</para>
231         </summary>
232       </Docs>
233       <AssemblyInfo>
234         <AssemblyVersion>2.0.0.0</AssemblyVersion>
235       </AssemblyInfo>
236     </Member>
237     <Member MemberName="NoClipping">
238       <MemberSignature Language="C#" Value="NoClipping" />
239       <MemberType>Field</MemberType>
240       <ReturnValue>
241         <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
242       </ReturnValue>
243       <Docs>
244         <since version=".NET 2.0" />
245         <summary>
246           <attribution license="cc4" from="Microsoft" modified="false" />
247           <para>Allows the overhanging parts of glyphs and unwrapped text reaching outside the formatting rectangle to show.</para>
248         </summary>
249       </Docs>
250       <AssemblyInfo>
251         <AssemblyVersion>2.0.0.0</AssemblyVersion>
252       </AssemblyInfo>
253     </Member>
254     <Member MemberName="NoFullWidthCharacterBreak">
255       <MemberSignature Language="C#" Value="NoFullWidthCharacterBreak" />
256       <MemberType>Field</MemberType>
257       <ReturnValue>
258         <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
259       </ReturnValue>
260       <Docs>
261         <since version=".NET 2.0" />
262         <remarks>
263           <attribution license="cc4" from="Microsoft" modified="false" />
264           <para>Prevents a line break at a double-wide character string, so that the line-breaking rule is equivalent to single-wide character strings. For example, <see cref="F:System.Windows.Forms.TextFormatFlags.NoFullWidthCharacterBreak" /> increases the readability of icon labels in Korean windows. This value has no effect unless <see cref="F:System.Windows.Forms.TextFormatFlags.WordBreak" /> is also specified.</para>
265         </remarks>
266         <summary>
267           <attribution license="cc4" from="Microsoft" modified="false" />
268           <para>Applies to Windows 98, Windows Me, Windows 2000, or Windows XP only:</para>
269         </summary>
270       </Docs>
271       <AssemblyInfo>
272         <AssemblyVersion>2.0.0.0</AssemblyVersion>
273       </AssemblyInfo>
274     </Member>
275     <Member MemberName="NoPadding">
276       <MemberSignature Language="C#" Value="NoPadding" />
277       <MemberType>Field</MemberType>
278       <ReturnValue>
279         <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
280       </ReturnValue>
281       <Docs>
282         <since version=".NET 2.0" />
283         <summary>
284           <attribution license="cc4" from="Microsoft" modified="false" />
285           <para>Does not add padding to the bounding rectangle.</para>
286         </summary>
287       </Docs>
288       <AssemblyInfo>
289         <AssemblyVersion>2.0.0.0</AssemblyVersion>
290       </AssemblyInfo>
291     </Member>
292     <Member MemberName="NoPrefix">
293       <MemberSignature Language="C#" Value="NoPrefix" />
294       <MemberType>Field</MemberType>
295       <ReturnValue>
296         <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
297       </ReturnValue>
298       <Docs>
299         <since version=".NET 2.0" />
300         <remarks>
301           <attribution license="cc4" from="Microsoft" modified="false" />
302           <para>Compare with <see cref="F:System.Windows.Forms.TextFormatFlags.HidePrefix" /> and <see cref="F:System.Windows.Forms.TextFormatFlags.PrefixOnly" />.</para>
303         </remarks>
304         <summary>
305           <attribution license="cc4" from="Microsoft" modified="false" />
306           <para>Turns off processing of prefix characters. Typically, the ampersand (&amp;) mnemonic-prefix character is interpreted as a directive to underscore the character that follows, and the double-ampersand (&amp;&amp;) mnemonic-prefix characters as a directive to print a single ampersand. By specifying <see cref="F:System.Windows.Forms.TextFormatFlags.NoPrefix" />, this processing is turned off. For example, an input string of "A&amp;bc&amp;&amp;d" with <see cref="F:System.Windows.Forms.TextFormatFlags.NoPrefix" /> applied would result in output of "A&amp;bc&amp;&amp;d".</para>
307         </summary>
308       </Docs>
309       <AssemblyInfo>
310         <AssemblyVersion>2.0.0.0</AssemblyVersion>
311       </AssemblyInfo>
312     </Member>
313     <Member MemberName="PathEllipsis">
314       <MemberSignature Language="C#" Value="PathEllipsis" />
315       <MemberType>Field</MemberType>
316       <ReturnValue>
317         <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
318       </ReturnValue>
319       <Docs>
320         <since version=".NET 2.0" />
321         <summary>
322           <attribution license="cc4" from="Microsoft" modified="false" />
323           <para>Removes the center of trimmed lines and replaces it with an ellipsis. </para>
324         </summary>
325       </Docs>
326       <AssemblyInfo>
327         <AssemblyVersion>2.0.0.0</AssemblyVersion>
328       </AssemblyInfo>
329     </Member>
330     <Member MemberName="PrefixOnly">
331       <MemberSignature Language="C#" Value="PrefixOnly" />
332       <MemberType>Field</MemberType>
333       <ReturnValue>
334         <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
335       </ReturnValue>
336       <Docs>
337         <since version=".NET 2.0" />
338         <remarks>
339           <attribution license="cc4" from="Microsoft" modified="false" />
340           <para>Draws only an underline at the position of the character following the ampersand (&amp;) prefix character. Does not draw any other characters in the string. For example, an input string of "A&amp;bc&amp;&amp;d" would result in output of " _   ".</para>
341           <para>Compare with <see cref="F:System.Windows.Forms.TextFormatFlags.HidePrefix" /> and <see cref="F:System.Windows.Forms.TextFormatFlags.NoPrefix" />.</para>
342         </remarks>
343         <summary>
344           <attribution license="cc4" from="Microsoft" modified="false" />
345           <para>Applies to Windows 2000 or Windows XP only: </para>
346         </summary>
347       </Docs>
348       <AssemblyInfo>
349         <AssemblyVersion>2.0.0.0</AssemblyVersion>
350       </AssemblyInfo>
351     </Member>
352     <Member MemberName="PreserveGraphicsClipping">
353       <MemberSignature Language="C#" Value="PreserveGraphicsClipping" />
354       <MemberType>Field</MemberType>
355       <ReturnValue>
356         <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
357       </ReturnValue>
358       <Docs>
359         <since version=".NET 2.0" />
360         <summary>
361           <attribution license="cc4" from="Microsoft" modified="false" />
362           <para>Preserves the clipping specified by a <see cref="T:System.Drawing.Graphics" /> object. Applies only to methods receiving an <see cref="T:System.Drawing.IDeviceContext" /> that is a <see cref="T:System.Drawing.Graphics" />.</para>
363         </summary>
364       </Docs>
365       <AssemblyInfo>
366         <AssemblyVersion>2.0.0.0</AssemblyVersion>
367       </AssemblyInfo>
368     </Member>
369     <Member MemberName="PreserveGraphicsTranslateTransform">
370       <MemberSignature Language="C#" Value="PreserveGraphicsTranslateTransform" />
371       <MemberType>Field</MemberType>
372       <ReturnValue>
373         <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
374       </ReturnValue>
375       <Docs>
376         <since version=".NET 2.0" />
377         <summary>
378           <attribution license="cc4" from="Microsoft" modified="false" />
379           <para>Preserves the transformation specified by a <see cref="T:System.Drawing.Graphics" />. Applies only to methods receiving an <see cref="T:System.Drawing.IDeviceContext" /> that is a <see cref="T:System.Drawing.Graphics" />.</para>
380         </summary>
381       </Docs>
382       <AssemblyInfo>
383         <AssemblyVersion>2.0.0.0</AssemblyVersion>
384       </AssemblyInfo>
385     </Member>
386     <Member MemberName="Right">
387       <MemberSignature Language="C#" Value="Right" />
388       <MemberType>Field</MemberType>
389       <ReturnValue>
390         <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
391       </ReturnValue>
392       <Docs>
393         <since version=".NET 2.0" />
394         <summary>
395           <attribution license="cc4" from="Microsoft" modified="false" />
396           <para>Aligns the text on the right side of the clipping area.</para>
397         </summary>
398       </Docs>
399       <AssemblyInfo>
400         <AssemblyVersion>2.0.0.0</AssemblyVersion>
401       </AssemblyInfo>
402     </Member>
403     <Member MemberName="RightToLeft">
404       <MemberSignature Language="C#" Value="RightToLeft" />
405       <MemberType>Field</MemberType>
406       <ReturnValue>
407         <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
408       </ReturnValue>
409       <Docs>
410         <since version=".NET 2.0" />
411         <summary>
412           <attribution license="cc4" from="Microsoft" modified="false" />
413           <para>Displays the text from right to left.</para>
414         </summary>
415       </Docs>
416       <AssemblyInfo>
417         <AssemblyVersion>2.0.0.0</AssemblyVersion>
418       </AssemblyInfo>
419     </Member>
420     <Member MemberName="SingleLine">
421       <MemberSignature Language="C#" Value="SingleLine" />
422       <MemberType>Field</MemberType>
423       <ReturnValue>
424         <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
425       </ReturnValue>
426       <Docs>
427         <since version=".NET 2.0" />
428         <summary>
429           <attribution license="cc4" from="Microsoft" modified="false" />
430           <para>Displays the text in a single line.</para>
431         </summary>
432       </Docs>
433       <AssemblyInfo>
434         <AssemblyVersion>2.0.0.0</AssemblyVersion>
435       </AssemblyInfo>
436     </Member>
437     <Member MemberName="TextBoxControl">
438       <MemberSignature Language="C#" Value="TextBoxControl" />
439       <MemberType>Field</MemberType>
440       <ReturnValue>
441         <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
442       </ReturnValue>
443       <Docs>
444         <since version=".NET 2.0" />
445         <summary>
446           <attribution license="cc4" from="Microsoft" modified="false" />
447           <para>Specifies the text should be formatted for display on a <see cref="T:System.Windows.Forms.TextBox" /> control.</para>
448         </summary>
449       </Docs>
450       <AssemblyInfo>
451         <AssemblyVersion>2.0.0.0</AssemblyVersion>
452       </AssemblyInfo>
453     </Member>
454     <Member MemberName="Top">
455       <MemberSignature Language="C#" Value="Top" />
456       <MemberType>Field</MemberType>
457       <ReturnValue>
458         <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
459       </ReturnValue>
460       <Docs>
461         <since version=".NET 2.0" />
462         <summary>
463           <attribution license="cc4" from="Microsoft" modified="false" />
464           <para>Aligns the text on the top of the bounding rectangle.</para>
465         </summary>
466       </Docs>
467       <AssemblyInfo>
468         <AssemblyVersion>2.0.0.0</AssemblyVersion>
469       </AssemblyInfo>
470     </Member>
471     <Member MemberName="VerticalCenter">
472       <MemberSignature Language="C#" Value="VerticalCenter" />
473       <MemberType>Field</MemberType>
474       <ReturnValue>
475         <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
476       </ReturnValue>
477       <Docs>
478         <since version=".NET 2.0" />
479         <summary>
480           <attribution license="cc4" from="Microsoft" modified="false" />
481           <para>Centers the text vertically, within the bounding rectangle.</para>
482         </summary>
483       </Docs>
484       <AssemblyInfo>
485         <AssemblyVersion>2.0.0.0</AssemblyVersion>
486       </AssemblyInfo>
487     </Member>
488     <Member MemberName="WordBreak">
489       <MemberSignature Language="C#" Value="WordBreak" />
490       <MemberType>Field</MemberType>
491       <ReturnValue>
492         <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
493       </ReturnValue>
494       <Docs>
495         <since version=".NET 2.0" />
496         <summary>
497           <attribution license="cc4" from="Microsoft" modified="false" />
498           <para>Breaks the text at the end of a word.</para>
499         </summary>
500       </Docs>
501       <AssemblyInfo>
502         <AssemblyVersion>2.0.0.0</AssemblyVersion>
503       </AssemblyInfo>
504     </Member>
505     <Member MemberName="WordEllipsis">
506       <MemberSignature Language="C#" Value="WordEllipsis" />
507       <MemberType>Field</MemberType>
508       <ReturnValue>
509         <ReturnType>System.Windows.Forms.TextFormatFlags</ReturnType>
510       </ReturnValue>
511       <Docs>
512         <since version=".NET 2.0" />
513         <summary>
514           <attribution license="cc4" from="Microsoft" modified="false" />
515           <para>Trims the line to the nearest word and an ellipsis is placed at the end of a trimmed line.</para>
516         </summary>
517       </Docs>
518       <AssemblyInfo>
519         <AssemblyVersion>2.0.0.0</AssemblyVersion>
520       </AssemblyInfo>
521     </Member>
522   </Members>
523 </Type>