← Back to branch summary

~ubuntu-branches/ubuntu/trusty/monodevelop/trusty-proposed

« back to all changes in this revision

Viewing changes to external/monomac/docs/en/MonoMac.CoreText/CTLine.xml

  • Committer: Package Import Robot
  • Author(s): Jo Shields
  • Date: 2013-05-12 09:46:03 UTC
  • mto: This revision was merged to the branch mainline in revision 29.
  • Revision ID: package-import@ubuntu.com-20130512094603-mad323bzcxvmcam0
Tags: upstream-4.0.5+dfsg
Import upstream version 4.0.5+dfsg

Show diffs side-by-side

added added

removed removed

Lines of Context:
external/monomac/docs/en/MonoMac.CoreText/CTLine.xml
24
24
  <Docs>
25
25
    <summary>To be added.</summary>
26
26
    <remarks>To be added.</remarks>
 
27
    <related type="sample" href="http://samples.xamarin.com/Samples/ByGuid?guid=cb71419a-f5de-4239-aa70-260ce1813e55">SimpleTextInput</related>
27
28
  </Docs>
28
29
  <Members>
29
30
    <Member MemberName=".ctor">
54
55
      </ReturnValue>
55
56
      <Parameters />
56
57
      <Docs>
57
 
        <summary>Releases the resourced used by the CTLine object.</summary>
 
58
        <summary>Releases the resources used by the CTLine object.</summary>
58
59
        <remarks>
59
60
          <para>The Dispose method releases the resources used by the CTLine class.</para>
60
61
          <para>Calling the Dispose method when you are finished using the CTLine ensures that all external resources used by this managed object are released as soon as possible.  Once you have invoked the Dispose method, the object is no longer useful and you should no longer make any calls to it.  For more information on releasing resources see ``Cleaning up Unmananaged Resources'' at http://msdn.microsoft.com/en-us/library/498928w2.aspx</para>
78
79
        <param name="disposing">
79
80
          <para>If set to <see langword="true" />, the method is invoked directly and will dispose manage and unmanaged resources;   If set to <see langword="false" /> the method is being called by the garbage collector finalizer and should only release unmanaged resources.</para>
80
81
        </param>
81
 
        <summary>Releases the resourced used by the CTLine object.</summary>
 
82
        <summary>Releases the resources used by the CTLine object.</summary>
82
83
        <remarks>
83
84
          <para>This Dispose method releases the resources used by the CTLine class.</para>
84
85
          <para>This method is called by both the Dispose() method and the object finalizer (Finalize).    When invoked by the Dispose method, the parameter disposting <paramref name="disposing" /> is set to <see langword="true" /> and any managed object references that this object holds are also disposed or released;  when invoked by the object finalizer, on the finalizer thread the value is set to <see langword="false" />. </para>
123
124
        </remarks>
124
125
      </Docs>
125
126
    </Member>
 
127
    <Member MemberName="GetBounds">
 
128
      <MemberSignature Language="C#" Value="public System.Drawing.RectangleF GetBounds (MonoMac.CoreText.CTLineBoundsOptions options);" />
 
129
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype System.Drawing.RectangleF GetBounds(valuetype MonoMac.CoreText.CTLineBoundsOptions options) cil managed" />
 
130
      <MemberType>Method</MemberType>
 
131
      <AssemblyInfo>
 
132
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
133
      </AssemblyInfo>
 
134
      <Attributes>
 
135
        <Attribute>
 
136
          <AttributeName>MonoMac.ObjCRuntime.Since(6, 0)</AttributeName>
 
137
        </Attribute>
 
138
      </Attributes>
 
139
      <ReturnValue>
 
140
        <ReturnType>System.Drawing.RectangleF</ReturnType>
 
141
      </ReturnValue>
 
142
      <Parameters>
 
143
        <Parameter Name="options" Type="MonoMac.CoreText.CTLineBoundsOptions" />
 
144
      </Parameters>
 
145
      <Docs>
 
146
        <param name="options">To be added.</param>
 
147
        <summary>To be added.</summary>
 
148
        <returns>To be added.</returns>
 
149
        <remarks>To be added.</remarks>
 
150
      </Docs>
 
151
    </Member>
126
152
    <Member MemberName="GetGlyphRuns">
127
153
      <MemberSignature Language="C#" Value="public MonoMac.CoreText.CTRun[] GetGlyphRuns ();" />
128
154
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class MonoMac.CoreText.CTRun[] GetGlyphRuns() cil managed" />
302
328
      </ReturnValue>
303
329
      <Parameters />
304
330
      <Docs>
305
 
        <summary>To be added.</summary>
306
 
        <returns>To be added.</returns>
307
 
        <remarks>To be added.</remarks>
 
331
        <summary>Returns the typorgraphic width of the line.</summary>
 
332
        <returns>The width of the line, or zero if there are any errors.</returns>
 
333
        <remarks>
 
334
          <para>
 
335
            Use the <see cref="M:MonoMac.CoreText.CTLine.GetTypographicBounds(out float, out float, out float)" /> method to retrieve more information about the typographical features of the line.
 
336
          </para>
 
337
          <para>
 
338
            Starting with iOS 6.0, the <see cref="M:MonoMac.CoreText.CTLine.GetBounds(MonoMac.CoreText.CTLineBoundsOptions)" /> provides finer typorgraphical information than this method.
 
339
          </para>
 
340
        </remarks>
308
341
      </Docs>
309
342
    </Member>
310
343
    <Member MemberName="GetTypographicBounds">
323
356
        <Parameter Name="leading" Type="System.Single&amp;" RefType="out" />
324
357
      </Parameters>
325
358
      <Docs>
326
 
        <param name="ascent">To be added.</param>
327
 
        <param name="descent">To be added.</param>
328
 
        <param name="leading">To be added.</param>
329
 
        <summary>To be added.</summary>
330
 
        <returns>To be added.</returns>
331
 
        <remarks>To be added.</remarks>
 
359
        <param name="ascent">Returns the ascent of the line.</param>
 
360
        <param name="descent">Returns the descent of the line.</param>
 
361
        <param name="leading">Returns the leading of the line.</param>
 
362
        <summary>Returns the typographic information about the line.</summary>
 
363
        <returns>The width of the line, or zero if there are any errors.</returns>
 
364
        <remarks>
 
365
          <para>
 
366
            Starting with iOS 6.0, the <see cref="M:MonoMac.CoreText.CTLine.GetBounds(MonoMac.CoreText.CTLineBoundsOptions)" /> provides finer typorgraphical information than this method.
 
367
          </para>
 
368
        </remarks>
332
369
      </Docs>
333
370
    </Member>
334
371
    <Member MemberName="GlyphCount">