← 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.PdfKit/PdfView.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.PdfKit/PdfView.xml
30
30
        <Attribute>
31
31
          <AttributeName>MonoMac.Foundation.Export("init")</AttributeName>
32
32
        </Attribute>
 
33
        <Attribute>
 
34
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
35
        </Attribute>
33
36
      </Attributes>
34
37
      <Parameters />
35
38
      <Docs>
49
52
        <Attribute>
50
53
          <AttributeName>MonoMac.Foundation.Export("initWithCoder:")</AttributeName>
51
54
        </Attribute>
 
55
        <Attribute>
 
56
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
57
        </Attribute>
52
58
      </Attributes>
53
59
      <Parameters>
54
60
        <Parameter Name="coder" Type="MonoMac.Foundation.NSCoder" />
66
72
      <AssemblyInfo>
67
73
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
68
74
      </AssemblyInfo>
 
75
      <Attributes>
 
76
        <Attribute>
 
77
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
78
        </Attribute>
 
79
      </Attributes>
69
80
      <Parameters>
70
81
        <Parameter Name="t" Type="MonoMac.Foundation.NSObjectFlag" />
71
82
      </Parameters>
72
83
      <Docs>
73
84
        <param name="t">Unused sentinel value, pass NSObjectFlag.Empty.</param>
74
 
        <summary>Constructor to call on derived classes to skip initialization and merely allocate the object.</summary>
 
85
        <summary>Constructor to call on derived classes when the derived class has an [Export] constructor.</summary>
75
86
        <remarks>
76
 
          <para>This constructor should be called by derived classes when they completely construct the object in managed code and merely want the runtime to allocate and initialize the NSObject.   This is required to implement the two-step initialization process that Objective-C uses, the first step is to perform the object allocation, the second step is to initialize the object.   When you invoke the constructor that takes the NSObjectFlag.Empty you taking advatnage of a direct path that goes all the way up to NSObject to merely allocate the object's memory and bind the Objective-C and C# objects together.    The actual initialization of the object is up to you.</para>
77
 
          <para>This constructor is typically used by the binding generator to allocate the object, but prevent the actual initialization to take place.   Once the allocation has taken place, the constructor has to initialize the object.   With constructors generated by the binding generator this means that it manually invokes one of the "init" methods to initialize the object.</para>
78
 
          <para>It is your responsability to completely initialize the object if you chain up using the NSObjectFlag.Empty path.</para>
79
 
          <para>In general, if your constructors invokes the NSObjectFlag.Empty base implementation, then it should be calling an Objective-C init method.   If this is not the case, you should instead chain to the proper constructor in your class. </para>
80
 
          <para>The argument value is ignored and merely ensures that the only code that is executed is the construction phase is the basic NSObject allocation and runtime type registration.  Typically the chaining would look like this:</para>
 
87
          <para>This constructor should be called by derived classes when they are initialized using an [Export] attribute. The argument value is ignore, typically the chaining would look like this:</para>
81
88
          <example>
82
89
            <code lang="C#">
83
 
//
84
 
// The NSObjectFlag merely allocates the object and registers the
85
 
// C# class with the Objective-C runtime if necessary, but no actual
86
 
// initXxx method is invoked, that is done later in the constructor
87
 
//
88
 
// This is taken from MonoMac's source code:
89
 
//
90
 
[Export ("initWithFrame:")]
91
 
public UIView (System.Drawing.RectangleF frame) : base (NSObjectFlag.Empty)
92
 
{
93
 
// Invoke the init method now.
94
 
        var initWithFrame = new Selector ("initWithFrame:").Handle;
95
 
        if (IsDirectBinding)
96
 
                Handle = MonoMac.ObjCRuntime.Messaging.IntPtr_objc_msgSend_RectangleF (this.Handle, initWithFrame, frame);
97
 
        else
98
 
                Handle = MonoMac.ObjCRuntime.Messaging.IntPtr_objc_msgSendSuper_RectangleF (this.SuperHandle, initWithFrame, frame);
99
 
}
 
90
public class MyClass : BaseClass {
 
91
    [Export ("initWithFoo:")]
 
92
    public MyClass (string foo) : base (NSObjectFlag.Empty)
 
93
    {
 
94
        ...
 
95
    }
100
96
</code>
101
97
          </example>
102
98
        </remarks>
109
105
      <AssemblyInfo>
110
106
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
111
107
      </AssemblyInfo>
 
108
      <Attributes>
 
109
        <Attribute>
 
110
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
111
        </Attribute>
 
112
      </Attributes>
112
113
      <Parameters>
113
114
        <Parameter Name="handle" Type="System.IntPtr" />
114
115
      </Parameters>
144
145
        <remarks>To be added.</remarks>
145
146
      </Docs>
146
147
    </Member>
 
148
    <Member MemberName="AnnotationHitNotification">
 
149
      <MemberSignature Language="C#" Value="public static MonoMac.Foundation.NSString AnnotationHitNotification { get; }" />
 
150
      <MemberSignature Language="ILAsm" Value=".property class MonoMac.Foundation.NSString AnnotationHitNotification" />
 
151
      <MemberType>Property</MemberType>
 
152
      <AssemblyInfo>
 
153
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
154
      </AssemblyInfo>
 
155
      <ReturnValue>
 
156
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
 
157
      </ReturnValue>
 
158
      <Docs>
 
159
        <summary>To be added.</summary>
 
160
        <value>To be added.</value>
 
161
        <remarks>
 
162
          <para id="tool-remark">This constant can be used with the <see cref="T:MonoTouch.Foundation.NSNotificationCenter" /> to register a listener for this notification.   This is an NSString instead of a string, because these values can be used as tokens in some native libraries instead of being used purely for their actual string content.    The 'notification' parameter to the callback contains extra information that is specific to the notification type.</para>
 
163
          <para id="tool-remark">If you want to subscribe to this notification, you can use the convenience <see cref="T:PdfView+Notifications" />.<see cref="M:PdfView+Notifications.ObserveAnnotationHit" /> method which offers strongly typed access to the parameters of the notification.</para>
 
164
          <para>The following example shows how to use the strongly typed Notifications class, to take the guesswork out of the available properties in the notification:</para>
 
165
          <example>
 
166
            <code lang="c#">
 
167
//
 
168
// Lambda style
 
169
//
 
170
 
 
171
// listening
 
172
notification = PdfView.Notifications.ObserveAnnotationHit ((sender, args) =&gt; {
 
173
    /* Access strongly typed args */
 
174
    Console.WriteLine ("Notification: {0}", args.Notification);
 
175
 
 
176
    Console.WriteLine ("AnnotationHit", args.AnnotationHit);
 
177
});
 
178
 
 
179
// To stop listening:
 
180
notification.Dispose ();
 
181
 
 
182
//
 
183
// Method style
 
184
//
 
185
NSObject notification;
 
186
void Callback (object sender, AnnotationHit args)
 
187
{
 
188
    // Access strongly typed args
 
189
    Console.WriteLine ("Notification: {0}", args.Notification);
 
190
 
 
191
    Console.WriteLine ("AnnotationHit", args.AnnotationHit);
 
192
}
 
193
 
 
194
void Setup ()
 
195
{
 
196
    notification = PdfView.Notifications.ObserveAnnotationHit (Callback);
 
197
}
 
198
 
 
199
void Teardown ()
 
200
{
 
201
    notification.Dispose ();
 
202
}</code>
 
203
          </example>
 
204
          <para>The following example shows how to use the notification with the DefaultCenter API:</para>
 
205
          <example>
 
206
            <code lang="c#">
 
207
// Lambda style
 
208
NSNotificationCenter.DefaultCenter.AddObserver (
 
209
        PdfView.AnnotationHitNotification, (notification) =&gt; {Console.WriteLine ("Received the notification PdfView", notification); }
 
210
 
 
211
 
 
212
// Method style
 
213
void Callback (NSNotification notification)
 
214
{
 
215
    Console.WriteLine ("Received a notification PdfView", notification);
 
216
}
 
217
 
 
218
void Setup ()
 
219
{
 
220
    NSNotificationCenter.DefaultCenter.AddObserver (PdfView.AnnotationHitNotification, Callback);
 
221
}
 
222
</code>
 
223
          </example>
 
224
        </remarks>
 
225
      </Docs>
 
226
    </Member>
147
227
    <Member MemberName="AnnotationsChanged">
148
228
      <MemberSignature Language="C#" Value="public virtual void AnnotationsChanged (MonoMac.PdfKit.PdfPage page);" />
149
229
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void AnnotationsChanged(class MonoMac.PdfKit.PdfPage page) cil managed" />
168
248
        <remarks>To be added.</remarks>
169
249
      </Docs>
170
250
    </Member>
 
251
    <Member MemberName="AnnotationWillHitNotification">
 
252
      <MemberSignature Language="C#" Value="public static MonoMac.Foundation.NSString AnnotationWillHitNotification { get; }" />
 
253
      <MemberSignature Language="ILAsm" Value=".property class MonoMac.Foundation.NSString AnnotationWillHitNotification" />
 
254
      <MemberType>Property</MemberType>
 
255
      <AssemblyInfo>
 
256
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
257
      </AssemblyInfo>
 
258
      <ReturnValue>
 
259
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
 
260
      </ReturnValue>
 
261
      <Docs>
 
262
        <summary>To be added.</summary>
 
263
        <value>To be added.</value>
 
264
        <remarks>
 
265
          <para id="tool-remark">This constant can be used with the <see cref="T:MonoTouch.Foundation.NSNotificationCenter" /> to register a listener for this notification.   This is an NSString instead of a string, because these values can be used as tokens in some native libraries instead of being used purely for their actual string content.    The 'notification' parameter to the callback contains extra information that is specific to the notification type.</para>
 
266
          <para id="tool-remark">If you want to subscribe to this notification, you can use the convenience <see cref="T:PdfView+Notifications" />.<see cref="M:PdfView+Notifications.ObserveAnnotationWillHit" /> method which offers strongly typed access to the parameters of the notification.</para>
 
267
          <para>The following example shows how to use the strongly typed Notifications class, to take the guesswork out of the available properties in the notification:</para>
 
268
          <example>
 
269
            <code lang="c#">
 
270
//
 
271
// Lambda style
 
272
//
 
273
 
 
274
// listening
 
275
notification = PdfView.Notifications.ObserveAnnotationWillHit ((sender, args) =&gt; {
 
276
    /* Access strongly typed args */
 
277
    Console.WriteLine ("Notification: {0}", args.Notification);
 
278
});
 
279
 
 
280
// To stop listening:
 
281
notification.Dispose ();
 
282
 
 
283
//
 
284
// Method style
 
285
//
 
286
NSObject notification;
 
287
void Callback (object sender, AnnotationWillHit args)
 
288
{
 
289
    // Access strongly typed args
 
290
    Console.WriteLine ("Notification: {0}", args.Notification);
 
291
}
 
292
 
 
293
void Setup ()
 
294
{
 
295
    notification = PdfView.Notifications.ObserveAnnotationWillHit (Callback);
 
296
}
 
297
 
 
298
void Teardown ()
 
299
{
 
300
    notification.Dispose ();
 
301
}</code>
 
302
          </example>
 
303
          <para>The following example shows how to use the notification with the DefaultCenter API:</para>
 
304
          <example>
 
305
            <code lang="c#">
 
306
// Lambda style
 
307
NSNotificationCenter.DefaultCenter.AddObserver (
 
308
        PdfView.AnnotationWillHitNotification, (notification) =&gt; {Console.WriteLine ("Received the notification PdfView", notification); }
 
309
 
 
310
 
 
311
// Method style
 
312
void Callback (NSNotification notification)
 
313
{
 
314
    Console.WriteLine ("Received a notification PdfView", notification);
 
315
}
 
316
 
 
317
void Setup ()
 
318
{
 
319
    NSNotificationCenter.DefaultCenter.AddObserver (PdfView.AnnotationWillHitNotification, Callback);
 
320
}
 
321
</code>
 
322
          </example>
 
323
        </remarks>
 
324
      </Docs>
 
325
    </Member>
171
326
    <Member MemberName="AutoScales">
172
327
      <MemberSignature Language="C#" Value="public virtual bool AutoScales { get; set; }" />
173
328
      <MemberSignature Language="ILAsm" Value=".property instance bool AutoScales" />
384
539
        <remarks>To be added.</remarks>
385
540
      </Docs>
386
541
    </Member>
 
542
    <Member MemberName="ChangedHistoryNotification">
 
543
      <MemberSignature Language="C#" Value="public static MonoMac.Foundation.NSString ChangedHistoryNotification { get; }" />
 
544
      <MemberSignature Language="ILAsm" Value=".property class MonoMac.Foundation.NSString ChangedHistoryNotification" />
 
545
      <MemberType>Property</MemberType>
 
546
      <AssemblyInfo>
 
547
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
548
      </AssemblyInfo>
 
549
      <ReturnValue>
 
550
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
 
551
      </ReturnValue>
 
552
      <Docs>
 
553
        <summary>To be added.</summary>
 
554
        <value>To be added.</value>
 
555
        <remarks>
 
556
          <para id="tool-remark">This constant can be used with the <see cref="T:MonoTouch.Foundation.NSNotificationCenter" /> to register a listener for this notification.   This is an NSString instead of a string, because these values can be used as tokens in some native libraries instead of being used purely for their actual string content.    The 'notification' parameter to the callback contains extra information that is specific to the notification type.</para>
 
557
          <para id="tool-remark">If you want to subscribe to this notification, you can use the convenience <see cref="T:PdfView+Notifications" />.<see cref="M:PdfView+Notifications.ObserveChangedHistory" /> method which offers strongly typed access to the parameters of the notification.</para>
 
558
          <para>The following example shows how to use the strongly typed Notifications class, to take the guesswork out of the available properties in the notification:</para>
 
559
          <example>
 
560
            <code lang="c#">
 
561
//
 
562
// Lambda style
 
563
//
 
564
 
 
565
// listening
 
566
notification = PdfView.Notifications.ObserveChangedHistory ((sender, args) =&gt; {
 
567
    /* Access strongly typed args */
 
568
    Console.WriteLine ("Notification: {0}", args.Notification);
 
569
});
 
570
 
 
571
// To stop listening:
 
572
notification.Dispose ();
 
573
 
 
574
//
 
575
// Method style
 
576
//
 
577
NSObject notification;
 
578
void Callback (object sender, ChangedHistory args)
 
579
{
 
580
    // Access strongly typed args
 
581
    Console.WriteLine ("Notification: {0}", args.Notification);
 
582
}
 
583
 
 
584
void Setup ()
 
585
{
 
586
    notification = PdfView.Notifications.ObserveChangedHistory (Callback);
 
587
}
 
588
 
 
589
void Teardown ()
 
590
{
 
591
    notification.Dispose ();
 
592
}</code>
 
593
          </example>
 
594
          <para>The following example shows how to use the notification with the DefaultCenter API:</para>
 
595
          <example>
 
596
            <code lang="c#">
 
597
// Lambda style
 
598
NSNotificationCenter.DefaultCenter.AddObserver (
 
599
        PdfView.ChangedHistoryNotification, (notification) =&gt; {Console.WriteLine ("Received the notification PdfView", notification); }
 
600
 
 
601
 
 
602
// Method style
 
603
void Callback (NSNotification notification)
 
604
{
 
605
    Console.WriteLine ("Received a notification PdfView", notification);
 
606
}
 
607
 
 
608
void Setup ()
 
609
{
 
610
    NSNotificationCenter.DefaultCenter.AddObserver (PdfView.ChangedHistoryNotification, Callback);
 
611
}
 
612
</code>
 
613
          </example>
 
614
        </remarks>
 
615
      </Docs>
 
616
    </Member>
387
617
    <Member MemberName="ClassHandle">
388
618
      <MemberSignature Language="C#" Value="public override IntPtr ClassHandle { get; }" />
389
619
      <MemberSignature Language="ILAsm" Value=".property instance native int ClassHandle" />
553
783
        <remarks>To be added.</remarks>
554
784
      </Docs>
555
785
    </Member>
 
786
    <Member MemberName="CopyPermissionNotification">
 
787
      <MemberSignature Language="C#" Value="public static MonoMac.Foundation.NSString CopyPermissionNotification { get; }" />
 
788
      <MemberSignature Language="ILAsm" Value=".property class MonoMac.Foundation.NSString CopyPermissionNotification" />
 
789
      <MemberType>Property</MemberType>
 
790
      <AssemblyInfo>
 
791
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
792
      </AssemblyInfo>
 
793
      <ReturnValue>
 
794
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
 
795
      </ReturnValue>
 
796
      <Docs>
 
797
        <summary>To be added.</summary>
 
798
        <value>To be added.</value>
 
799
        <remarks>
 
800
          <para id="tool-remark">This constant can be used with the <see cref="T:MonoTouch.Foundation.NSNotificationCenter" /> to register a listener for this notification.   This is an NSString instead of a string, because these values can be used as tokens in some native libraries instead of being used purely for their actual string content.    The 'notification' parameter to the callback contains extra information that is specific to the notification type.</para>
 
801
          <para id="tool-remark">If you want to subscribe to this notification, you can use the convenience <see cref="T:PdfView+Notifications" />.<see cref="M:PdfView+Notifications.ObserveCopyPermission" /> method which offers strongly typed access to the parameters of the notification.</para>
 
802
          <para>The following example shows how to use the strongly typed Notifications class, to take the guesswork out of the available properties in the notification:</para>
 
803
          <example>
 
804
            <code lang="c#">
 
805
//
 
806
// Lambda style
 
807
//
 
808
 
 
809
// listening
 
810
notification = PdfView.Notifications.ObserveCopyPermission ((sender, args) =&gt; {
 
811
    /* Access strongly typed args */
 
812
    Console.WriteLine ("Notification: {0}", args.Notification);
 
813
});
 
814
 
 
815
// To stop listening:
 
816
notification.Dispose ();
 
817
 
 
818
//
 
819
// Method style
 
820
//
 
821
NSObject notification;
 
822
void Callback (object sender, CopyPermission args)
 
823
{
 
824
    // Access strongly typed args
 
825
    Console.WriteLine ("Notification: {0}", args.Notification);
 
826
}
 
827
 
 
828
void Setup ()
 
829
{
 
830
    notification = PdfView.Notifications.ObserveCopyPermission (Callback);
 
831
}
 
832
 
 
833
void Teardown ()
 
834
{
 
835
    notification.Dispose ();
 
836
}</code>
 
837
          </example>
 
838
          <para>The following example shows how to use the notification with the DefaultCenter API:</para>
 
839
          <example>
 
840
            <code lang="c#">
 
841
// Lambda style
 
842
NSNotificationCenter.DefaultCenter.AddObserver (
 
843
        PdfView.CopyPermissionNotification, (notification) =&gt; {Console.WriteLine ("Received the notification PdfView", notification); }
 
844
 
 
845
 
 
846
// Method style
 
847
void Callback (NSNotification notification)
 
848
{
 
849
    Console.WriteLine ("Received a notification PdfView", notification);
 
850
}
 
851
 
 
852
void Setup ()
 
853
{
 
854
    NSNotificationCenter.DefaultCenter.AddObserver (PdfView.CopyPermissionNotification, Callback);
 
855
}
 
856
</code>
 
857
          </example>
 
858
        </remarks>
 
859
      </Docs>
 
860
    </Member>
556
861
    <Member MemberName="CurrentDestination">
557
862
      <MemberSignature Language="C#" Value="public virtual MonoMac.PdfKit.PdfDestination CurrentDestination { get; }" />
558
863
      <MemberSignature Language="ILAsm" Value=".property instance class MonoMac.PdfKit.PdfDestination CurrentDestination" />
631
936
      </ReturnValue>
632
937
      <Docs>
633
938
        <summary>An instance of the MonoMac.PdfKit.PdfViewDelegate model class which acts as the class delegate.</summary>
634
 
        <value>The instance of the MonoMac.PdfKit.PdfViewDelegate model class</value>
 
939
        <value>
 
940
          <para>The instance of the MonoMac.PdfKit.PdfViewDelegate model class</para>
 
941
          <para tool="nullallowed">This value can be <see langword="null" />.</para>
 
942
        </value>
635
943
        <remarks>
636
944
          <para>The delegate instance assigned to this object will be used to handle events or provide data on demand to this class.</para>
637
945
          <para>When setting the Delegate or WeakDelegate values events will be delivered to the specified instance instead of being delivered to the C#-style events</para>
663
971
        <remarks>To be added.</remarks>
664
972
      </Docs>
665
973
    </Member>
 
974
    <Member MemberName="DisplayBoxChangedNotification">
 
975
      <MemberSignature Language="C#" Value="public static MonoMac.Foundation.NSString DisplayBoxChangedNotification { get; }" />
 
976
      <MemberSignature Language="ILAsm" Value=".property class MonoMac.Foundation.NSString DisplayBoxChangedNotification" />
 
977
      <MemberType>Property</MemberType>
 
978
      <AssemblyInfo>
 
979
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
980
      </AssemblyInfo>
 
981
      <ReturnValue>
 
982
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
 
983
      </ReturnValue>
 
984
      <Docs>
 
985
        <summary>To be added.</summary>
 
986
        <value>To be added.</value>
 
987
        <remarks>
 
988
          <para id="tool-remark">This constant can be used with the <see cref="T:MonoTouch.Foundation.NSNotificationCenter" /> to register a listener for this notification.   This is an NSString instead of a string, because these values can be used as tokens in some native libraries instead of being used purely for their actual string content.    The 'notification' parameter to the callback contains extra information that is specific to the notification type.</para>
 
989
          <para id="tool-remark">If you want to subscribe to this notification, you can use the convenience <see cref="T:PdfView+Notifications" />.<see cref="M:PdfView+Notifications.ObserveDisplayBoxChanged" /> method which offers strongly typed access to the parameters of the notification.</para>
 
990
          <para>The following example shows how to use the strongly typed Notifications class, to take the guesswork out of the available properties in the notification:</para>
 
991
          <example>
 
992
            <code lang="c#">
 
993
//
 
994
// Lambda style
 
995
//
 
996
 
 
997
// listening
 
998
notification = PdfView.Notifications.ObserveDisplayBoxChanged ((sender, args) =&gt; {
 
999
    /* Access strongly typed args */
 
1000
    Console.WriteLine ("Notification: {0}", args.Notification);
 
1001
});
 
1002
 
 
1003
// To stop listening:
 
1004
notification.Dispose ();
 
1005
 
 
1006
//
 
1007
// Method style
 
1008
//
 
1009
NSObject notification;
 
1010
void Callback (object sender, DisplayBoxChanged args)
 
1011
{
 
1012
    // Access strongly typed args
 
1013
    Console.WriteLine ("Notification: {0}", args.Notification);
 
1014
}
 
1015
 
 
1016
void Setup ()
 
1017
{
 
1018
    notification = PdfView.Notifications.ObserveDisplayBoxChanged (Callback);
 
1019
}
 
1020
 
 
1021
void Teardown ()
 
1022
{
 
1023
    notification.Dispose ();
 
1024
}</code>
 
1025
          </example>
 
1026
          <para>The following example shows how to use the notification with the DefaultCenter API:</para>
 
1027
          <example>
 
1028
            <code lang="c#">
 
1029
// Lambda style
 
1030
NSNotificationCenter.DefaultCenter.AddObserver (
 
1031
        PdfView.DisplayBoxChangedNotification, (notification) =&gt; {Console.WriteLine ("Received the notification PdfView", notification); }
 
1032
 
 
1033
 
 
1034
// Method style
 
1035
void Callback (NSNotification notification)
 
1036
{
 
1037
    Console.WriteLine ("Received a notification PdfView", notification);
 
1038
}
 
1039
 
 
1040
void Setup ()
 
1041
{
 
1042
    NSNotificationCenter.DefaultCenter.AddObserver (PdfView.DisplayBoxChangedNotification, Callback);
 
1043
}
 
1044
</code>
 
1045
          </example>
 
1046
        </remarks>
 
1047
      </Docs>
 
1048
    </Member>
666
1049
    <Member MemberName="DisplayMode">
667
1050
      <MemberSignature Language="C#" Value="public virtual MonoMac.PdfKit.PdfDisplayMode DisplayMode { get; set; }" />
668
1051
      <MemberSignature Language="ILAsm" Value=".property instance valuetype MonoMac.PdfKit.PdfDisplayMode DisplayMode" />
687
1070
        <remarks>To be added.</remarks>
688
1071
      </Docs>
689
1072
    </Member>
 
1073
    <Member MemberName="DisplayModeChangedNotification">
 
1074
      <MemberSignature Language="C#" Value="public static MonoMac.Foundation.NSString DisplayModeChangedNotification { get; }" />
 
1075
      <MemberSignature Language="ILAsm" Value=".property class MonoMac.Foundation.NSString DisplayModeChangedNotification" />
 
1076
      <MemberType>Property</MemberType>
 
1077
      <AssemblyInfo>
 
1078
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
1079
      </AssemblyInfo>
 
1080
      <ReturnValue>
 
1081
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
 
1082
      </ReturnValue>
 
1083
      <Docs>
 
1084
        <summary>To be added.</summary>
 
1085
        <value>To be added.</value>
 
1086
        <remarks>
 
1087
          <para id="tool-remark">This constant can be used with the <see cref="T:MonoTouch.Foundation.NSNotificationCenter" /> to register a listener for this notification.   This is an NSString instead of a string, because these values can be used as tokens in some native libraries instead of being used purely for their actual string content.    The 'notification' parameter to the callback contains extra information that is specific to the notification type.</para>
 
1088
          <para id="tool-remark">If you want to subscribe to this notification, you can use the convenience <see cref="T:PdfView+Notifications" />.<see cref="M:PdfView+Notifications.ObserveDisplayModeChanged" /> method which offers strongly typed access to the parameters of the notification.</para>
 
1089
          <para>The following example shows how to use the strongly typed Notifications class, to take the guesswork out of the available properties in the notification:</para>
 
1090
          <example>
 
1091
            <code lang="c#">
 
1092
//
 
1093
// Lambda style
 
1094
//
 
1095
 
 
1096
// listening
 
1097
notification = PdfView.Notifications.ObserveDisplayModeChanged ((sender, args) =&gt; {
 
1098
    /* Access strongly typed args */
 
1099
    Console.WriteLine ("Notification: {0}", args.Notification);
 
1100
});
 
1101
 
 
1102
// To stop listening:
 
1103
notification.Dispose ();
 
1104
 
 
1105
//
 
1106
// Method style
 
1107
//
 
1108
NSObject notification;
 
1109
void Callback (object sender, DisplayModeChanged args)
 
1110
{
 
1111
    // Access strongly typed args
 
1112
    Console.WriteLine ("Notification: {0}", args.Notification);
 
1113
}
 
1114
 
 
1115
void Setup ()
 
1116
{
 
1117
    notification = PdfView.Notifications.ObserveDisplayModeChanged (Callback);
 
1118
}
 
1119
 
 
1120
void Teardown ()
 
1121
{
 
1122
    notification.Dispose ();
 
1123
}</code>
 
1124
          </example>
 
1125
          <para>The following example shows how to use the notification with the DefaultCenter API:</para>
 
1126
          <example>
 
1127
            <code lang="c#">
 
1128
// Lambda style
 
1129
NSNotificationCenter.DefaultCenter.AddObserver (
 
1130
        PdfView.DisplayModeChangedNotification, (notification) =&gt; {Console.WriteLine ("Received the notification PdfView", notification); }
 
1131
 
 
1132
 
 
1133
// Method style
 
1134
void Callback (NSNotification notification)
 
1135
{
 
1136
    Console.WriteLine ("Received a notification PdfView", notification);
 
1137
}
 
1138
 
 
1139
void Setup ()
 
1140
{
 
1141
    NSNotificationCenter.DefaultCenter.AddObserver (PdfView.DisplayModeChangedNotification, Callback);
 
1142
}
 
1143
</code>
 
1144
          </example>
 
1145
        </remarks>
 
1146
      </Docs>
 
1147
    </Member>
690
1148
    <Member MemberName="DisplaysAsBook">
691
1149
      <MemberSignature Language="C#" Value="public virtual bool DisplaysAsBook { get; set; }" />
692
1150
      <MemberSignature Language="ILAsm" Value=".property instance bool DisplaysAsBook" />
752
1210
        <param name="disposing">
753
1211
          <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>
754
1212
        </param>
755
 
        <summary>Releases the resourced used by the PdfView object.</summary>
 
1213
        <summary>Releases the resources used by the PdfView object.</summary>
756
1214
        <remarks>
757
1215
          <para>This Dispose method releases the resources used by the PdfView class.</para>
758
1216
          <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>
785
1243
        <remarks>To be added.</remarks>
786
1244
      </Docs>
787
1245
    </Member>
 
1246
    <Member MemberName="DocumentChangedNotification">
 
1247
      <MemberSignature Language="C#" Value="public static MonoMac.Foundation.NSString DocumentChangedNotification { get; }" />
 
1248
      <MemberSignature Language="ILAsm" Value=".property class MonoMac.Foundation.NSString DocumentChangedNotification" />
 
1249
      <MemberType>Property</MemberType>
 
1250
      <AssemblyInfo>
 
1251
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
1252
      </AssemblyInfo>
 
1253
      <ReturnValue>
 
1254
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
 
1255
      </ReturnValue>
 
1256
      <Docs>
 
1257
        <summary>To be added.</summary>
 
1258
        <value>To be added.</value>
 
1259
        <remarks>
 
1260
          <para id="tool-remark">This constant can be used with the <see cref="T:MonoTouch.Foundation.NSNotificationCenter" /> to register a listener for this notification.   This is an NSString instead of a string, because these values can be used as tokens in some native libraries instead of being used purely for their actual string content.    The 'notification' parameter to the callback contains extra information that is specific to the notification type.</para>
 
1261
          <para id="tool-remark">If you want to subscribe to this notification, you can use the convenience <see cref="T:PdfView+Notifications" />.<see cref="M:PdfView+Notifications.ObserveDocumentChanged" /> method which offers strongly typed access to the parameters of the notification.</para>
 
1262
          <para>The following example shows how to use the strongly typed Notifications class, to take the guesswork out of the available properties in the notification:</para>
 
1263
          <example>
 
1264
            <code lang="c#">
 
1265
//
 
1266
// Lambda style
 
1267
//
 
1268
 
 
1269
// listening
 
1270
notification = PdfView.Notifications.ObserveDocumentChanged ((sender, args) =&gt; {
 
1271
    /* Access strongly typed args */
 
1272
    Console.WriteLine ("Notification: {0}", args.Notification);
 
1273
});
 
1274
 
 
1275
// To stop listening:
 
1276
notification.Dispose ();
 
1277
 
 
1278
//
 
1279
// Method style
 
1280
//
 
1281
NSObject notification;
 
1282
void Callback (object sender, DocumentChanged args)
 
1283
{
 
1284
    // Access strongly typed args
 
1285
    Console.WriteLine ("Notification: {0}", args.Notification);
 
1286
}
 
1287
 
 
1288
void Setup ()
 
1289
{
 
1290
    notification = PdfView.Notifications.ObserveDocumentChanged (Callback);
 
1291
}
 
1292
 
 
1293
void Teardown ()
 
1294
{
 
1295
    notification.Dispose ();
 
1296
}</code>
 
1297
          </example>
 
1298
          <para>The following example shows how to use the notification with the DefaultCenter API:</para>
 
1299
          <example>
 
1300
            <code lang="c#">
 
1301
// Lambda style
 
1302
NSNotificationCenter.DefaultCenter.AddObserver (
 
1303
        PdfView.DocumentChangedNotification, (notification) =&gt; {Console.WriteLine ("Received the notification PdfView", notification); }
 
1304
 
 
1305
 
 
1306
// Method style
 
1307
void Callback (NSNotification notification)
 
1308
{
 
1309
    Console.WriteLine ("Received a notification PdfView", notification);
 
1310
}
 
1311
 
 
1312
void Setup ()
 
1313
{
 
1314
    NSNotificationCenter.DefaultCenter.AddObserver (PdfView.DocumentChangedNotification, Callback);
 
1315
}
 
1316
</code>
 
1317
          </example>
 
1318
        </remarks>
 
1319
      </Docs>
 
1320
    </Member>
788
1321
    <Member MemberName="DocumentView">
789
1322
      <MemberSignature Language="C#" Value="public virtual MonoMac.AppKit.NSView DocumentView { get; }" />
790
1323
      <MemberSignature Language="ILAsm" Value=".property instance class MonoMac.AppKit.NSView DocumentView" />
1256
1789
        <remarks>If you assign a value to this event, this will reset the value for the WeakDelegate property to an internal handler that maps delegates to events.</remarks>
1257
1790
      </Docs>
1258
1791
    </Member>
 
1792
    <Member MemberName="PageChangedNotification">
 
1793
      <MemberSignature Language="C#" Value="public static MonoMac.Foundation.NSString PageChangedNotification { get; }" />
 
1794
      <MemberSignature Language="ILAsm" Value=".property class MonoMac.Foundation.NSString PageChangedNotification" />
 
1795
      <MemberType>Property</MemberType>
 
1796
      <AssemblyInfo>
 
1797
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
1798
      </AssemblyInfo>
 
1799
      <ReturnValue>
 
1800
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
 
1801
      </ReturnValue>
 
1802
      <Docs>
 
1803
        <summary>To be added.</summary>
 
1804
        <value>To be added.</value>
 
1805
        <remarks>
 
1806
          <para id="tool-remark">This constant can be used with the <see cref="T:MonoTouch.Foundation.NSNotificationCenter" /> to register a listener for this notification.   This is an NSString instead of a string, because these values can be used as tokens in some native libraries instead of being used purely for their actual string content.    The 'notification' parameter to the callback contains extra information that is specific to the notification type.</para>
 
1807
          <para id="tool-remark">If you want to subscribe to this notification, you can use the convenience <see cref="T:PdfView+Notifications" />.<see cref="M:PdfView+Notifications.ObservePageChanged" /> method which offers strongly typed access to the parameters of the notification.</para>
 
1808
          <para>The following example shows how to use the strongly typed Notifications class, to take the guesswork out of the available properties in the notification:</para>
 
1809
          <example>
 
1810
            <code lang="c#">
 
1811
//
 
1812
// Lambda style
 
1813
//
 
1814
 
 
1815
// listening
 
1816
notification = PdfView.Notifications.ObservePageChanged ((sender, args) =&gt; {
 
1817
    /* Access strongly typed args */
 
1818
    Console.WriteLine ("Notification: {0}", args.Notification);
 
1819
});
 
1820
 
 
1821
// To stop listening:
 
1822
notification.Dispose ();
 
1823
 
 
1824
//
 
1825
// Method style
 
1826
//
 
1827
NSObject notification;
 
1828
void Callback (object sender, PageChanged args)
 
1829
{
 
1830
    // Access strongly typed args
 
1831
    Console.WriteLine ("Notification: {0}", args.Notification);
 
1832
}
 
1833
 
 
1834
void Setup ()
 
1835
{
 
1836
    notification = PdfView.Notifications.ObservePageChanged (Callback);
 
1837
}
 
1838
 
 
1839
void Teardown ()
 
1840
{
 
1841
    notification.Dispose ();
 
1842
}</code>
 
1843
          </example>
 
1844
          <para>The following example shows how to use the notification with the DefaultCenter API:</para>
 
1845
          <example>
 
1846
            <code lang="c#">
 
1847
// Lambda style
 
1848
NSNotificationCenter.DefaultCenter.AddObserver (
 
1849
        PdfView.PageChangedNotification, (notification) =&gt; {Console.WriteLine ("Received the notification PdfView", notification); }
 
1850
 
 
1851
 
 
1852
// Method style
 
1853
void Callback (NSNotification notification)
 
1854
{
 
1855
    Console.WriteLine ("Received a notification PdfView", notification);
 
1856
}
 
1857
 
 
1858
void Setup ()
 
1859
{
 
1860
    NSNotificationCenter.DefaultCenter.AddObserver (PdfView.PageChangedNotification, Callback);
 
1861
}
 
1862
</code>
 
1863
          </example>
 
1864
        </remarks>
 
1865
      </Docs>
 
1866
    </Member>
1259
1867
    <Member MemberName="PerformAction">
1260
1868
      <MemberSignature Language="C#" Value="public virtual void PerformAction (MonoMac.PdfKit.PdfAction action);" />
1261
1869
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void PerformAction(class MonoMac.PdfKit.PdfAction action) cil managed" />
1404
2012
        <remarks>To be added.</remarks>
1405
2013
      </Docs>
1406
2014
    </Member>
 
2015
    <Member MemberName="ScaleChangedNotification">
 
2016
      <MemberSignature Language="C#" Value="public static MonoMac.Foundation.NSString ScaleChangedNotification { get; }" />
 
2017
      <MemberSignature Language="ILAsm" Value=".property class MonoMac.Foundation.NSString ScaleChangedNotification" />
 
2018
      <MemberType>Property</MemberType>
 
2019
      <AssemblyInfo>
 
2020
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
2021
      </AssemblyInfo>
 
2022
      <ReturnValue>
 
2023
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
 
2024
      </ReturnValue>
 
2025
      <Docs>
 
2026
        <summary>To be added.</summary>
 
2027
        <value>To be added.</value>
 
2028
        <remarks>
 
2029
          <para id="tool-remark">This constant can be used with the <see cref="T:MonoTouch.Foundation.NSNotificationCenter" /> to register a listener for this notification.   This is an NSString instead of a string, because these values can be used as tokens in some native libraries instead of being used purely for their actual string content.    The 'notification' parameter to the callback contains extra information that is specific to the notification type.</para>
 
2030
          <para id="tool-remark">If you want to subscribe to this notification, you can use the convenience <see cref="T:PdfView+Notifications" />.<see cref="M:PdfView+Notifications.ObserveScaleChanged" /> method which offers strongly typed access to the parameters of the notification.</para>
 
2031
          <para>The following example shows how to use the strongly typed Notifications class, to take the guesswork out of the available properties in the notification:</para>
 
2032
          <example>
 
2033
            <code lang="c#">
 
2034
//
 
2035
// Lambda style
 
2036
//
 
2037
 
 
2038
// listening
 
2039
notification = PdfView.Notifications.ObserveScaleChanged ((sender, args) =&gt; {
 
2040
    /* Access strongly typed args */
 
2041
    Console.WriteLine ("Notification: {0}", args.Notification);
 
2042
});
 
2043
 
 
2044
// To stop listening:
 
2045
notification.Dispose ();
 
2046
 
 
2047
//
 
2048
// Method style
 
2049
//
 
2050
NSObject notification;
 
2051
void Callback (object sender, ScaleChanged args)
 
2052
{
 
2053
    // Access strongly typed args
 
2054
    Console.WriteLine ("Notification: {0}", args.Notification);
 
2055
}
 
2056
 
 
2057
void Setup ()
 
2058
{
 
2059
    notification = PdfView.Notifications.ObserveScaleChanged (Callback);
 
2060
}
 
2061
 
 
2062
void Teardown ()
 
2063
{
 
2064
    notification.Dispose ();
 
2065
}</code>
 
2066
          </example>
 
2067
          <para>The following example shows how to use the notification with the DefaultCenter API:</para>
 
2068
          <example>
 
2069
            <code lang="c#">
 
2070
// Lambda style
 
2071
NSNotificationCenter.DefaultCenter.AddObserver (
 
2072
        PdfView.ScaleChangedNotification, (notification) =&gt; {Console.WriteLine ("Received the notification PdfView", notification); }
 
2073
 
 
2074
 
 
2075
// Method style
 
2076
void Callback (NSNotification notification)
 
2077
{
 
2078
    Console.WriteLine ("Received a notification PdfView", notification);
 
2079
}
 
2080
 
 
2081
void Setup ()
 
2082
{
 
2083
    NSNotificationCenter.DefaultCenter.AddObserver (PdfView.ScaleChangedNotification, Callback);
 
2084
}
 
2085
</code>
 
2086
          </example>
 
2087
        </remarks>
 
2088
      </Docs>
 
2089
    </Member>
1407
2090
    <Member MemberName="ScaleFactor">
1408
2091
      <MemberSignature Language="C#" Value="public virtual float ScaleFactor { get; set; }" />
1409
2092
      <MemberSignature Language="ILAsm" Value=".property instance float32 ScaleFactor" />
1476
2159
        <remarks>To be added.</remarks>
1477
2160
      </Docs>
1478
2161
    </Member>
 
2162
    <Member MemberName="SelectionChangedNotification">
 
2163
      <MemberSignature Language="C#" Value="public static MonoMac.Foundation.NSString SelectionChangedNotification { get; }" />
 
2164
      <MemberSignature Language="ILAsm" Value=".property class MonoMac.Foundation.NSString SelectionChangedNotification" />
 
2165
      <MemberType>Property</MemberType>
 
2166
      <AssemblyInfo>
 
2167
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
2168
      </AssemblyInfo>
 
2169
      <ReturnValue>
 
2170
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
 
2171
      </ReturnValue>
 
2172
      <Docs>
 
2173
        <summary>To be added.</summary>
 
2174
        <value>To be added.</value>
 
2175
        <remarks>
 
2176
          <para id="tool-remark">This constant can be used with the <see cref="T:MonoTouch.Foundation.NSNotificationCenter" /> to register a listener for this notification.   This is an NSString instead of a string, because these values can be used as tokens in some native libraries instead of being used purely for their actual string content.    The 'notification' parameter to the callback contains extra information that is specific to the notification type.</para>
 
2177
          <para id="tool-remark">If you want to subscribe to this notification, you can use the convenience <see cref="T:PdfView+Notifications" />.<see cref="M:PdfView+Notifications.ObserveSelectionChanged" /> method which offers strongly typed access to the parameters of the notification.</para>
 
2178
          <para>The following example shows how to use the strongly typed Notifications class, to take the guesswork out of the available properties in the notification:</para>
 
2179
          <example>
 
2180
            <code lang="c#">
 
2181
//
 
2182
// Lambda style
 
2183
//
 
2184
 
 
2185
// listening
 
2186
notification = PdfView.Notifications.ObserveSelectionChanged ((sender, args) =&gt; {
 
2187
    /* Access strongly typed args */
 
2188
    Console.WriteLine ("Notification: {0}", args.Notification);
 
2189
});
 
2190
 
 
2191
// To stop listening:
 
2192
notification.Dispose ();
 
2193
 
 
2194
//
 
2195
// Method style
 
2196
//
 
2197
NSObject notification;
 
2198
void Callback (object sender, SelectionChanged args)
 
2199
{
 
2200
    // Access strongly typed args
 
2201
    Console.WriteLine ("Notification: {0}", args.Notification);
 
2202
}
 
2203
 
 
2204
void Setup ()
 
2205
{
 
2206
    notification = PdfView.Notifications.ObserveSelectionChanged (Callback);
 
2207
}
 
2208
 
 
2209
void Teardown ()
 
2210
{
 
2211
    notification.Dispose ();
 
2212
}</code>
 
2213
          </example>
 
2214
          <para>The following example shows how to use the notification with the DefaultCenter API:</para>
 
2215
          <example>
 
2216
            <code lang="c#">
 
2217
// Lambda style
 
2218
NSNotificationCenter.DefaultCenter.AddObserver (
 
2219
        PdfView.SelectionChangedNotification, (notification) =&gt; {Console.WriteLine ("Received the notification PdfView", notification); }
 
2220
 
 
2221
 
 
2222
// Method style
 
2223
void Callback (NSNotification notification)
 
2224
{
 
2225
    Console.WriteLine ("Received a notification PdfView", notification);
 
2226
}
 
2227
 
 
2228
void Setup ()
 
2229
{
 
2230
    NSNotificationCenter.DefaultCenter.AddObserver (PdfView.SelectionChangedNotification, Callback);
 
2231
}
 
2232
</code>
 
2233
          </example>
 
2234
        </remarks>
 
2235
      </Docs>
 
2236
    </Member>
1479
2237
    <Member MemberName="SetCurrentSelection">
1480
2238
      <MemberSignature Language="C#" Value="public virtual void SetCurrentSelection (MonoMac.PdfKit.PdfSelection selection, bool animate);" />
1481
2239
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void SetCurrentSelection(class MonoMac.PdfKit.PdfSelection selection, bool animate) cil managed" />
1655
2413
      </ReturnValue>
1656
2414
      <Docs>
1657
2415
        <summary>An object that can respond to the delegate protocol for this type</summary>
1658
 
        <value>The instance that will respond to events and data requests.</value>
 
2416
        <value>
 
2417
          <para>The instance that will respond to events and data requests.</para>
 
2418
          <para tool="nullallowed">This value can be <see langword="null" />.</para>
 
2419
        </value>
1659
2420
        <remarks>
1660
2421
          <para>The delegate instance assigned to this object will be used to handle events or provide data on demand to this class.</para>
1661
2422
          <para>When setting the Delegate or WeakDelegate values events will be delivered to the specified instance instead of being delivered to the C#-style events</para>