-
Notifications
You must be signed in to change notification settings - Fork 1
/
ScintillaNET.xml
5028 lines (5020 loc) · 245 KB
/
ScintillaNET.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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0"?>
<doc>
<assembly>
<name>ScintillaNET</name>
</assembly>
<members>
<member name="T:ScintillaNET.Annotation">
<summary>
Represents a customizable read-only block of text which can be displayed below
each line in a <see cref="T:ScintillaNET.Scintilla"/> control.
</summary>
</member>
<member name="M:ScintillaNET.Annotation.Clear">
<summary>
Removes all text and styles associated with the annotation.
</summary>
</member>
<member name="M:ScintillaNET.Annotation.Equals(System.Object)">
<summary>
Overridden. Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
</summary>
<param name="obj">The object to compare with the current object.</param>
<returns>
true if the specified <see cref="T:System.Object"/> is equal to the
current <see cref="T:System.Object"/>; otherwise, false.
</returns>
</member>
<member name="M:ScintillaNET.Annotation.Equals(ScintillaNET.Annotation)">
<summary>
Determines whether the specified <see cref="T:ScintillaNET.Annotation"/> is equal to the current <see cref="T:ScintillaNET.Annotation"/>.
</summary>
<param name="a">The annotation to compare with the current annotation.</param>
<returns>
true if the specified <see cref="T:ScintillaNET.Annotation"/> is equal to the
current <see cref="T:ScintillaNET.Annotation"/>; otherwise, false.
</returns>
</member>
<member name="M:ScintillaNET.Annotation.GetHashCode">
<summary>
Overridden. Serves as a hash function for a particular type.
</summary>
<returns>A hash code for the current <see cref="T:System.Object"/>.</returns>
</member>
<member name="M:ScintillaNET.Annotation.GetStyles">
<summary>
Returns a <see cref="T:ScintillaNET.StyleRun"/> enumerable representing the individual character styling of the annotation text.
</summary>
<returns>
A <see cref="T:ScintillaNET.StyleRun"/> enumerable representing the individual character styling,
where the <see cref="P:ScintillaNET.StyleRun.Length"/> property of each run represents the number
of characters the run spans.
</returns>
</member>
<member name="M:ScintillaNET.Annotation.SetStyles(System.Collections.Generic.IEnumerable{ScintillaNET.StyleRun})">
<summary>
Uses the enumerable <see cref="T:ScintillaNET.StyleRun"/> specified to individually style characters in the annotation text.
</summary>
<param name="styles">
The enumerable <see cref="T:ScintillaNET.StyleRun"/> indicating how to style the annotation text,
where the <see cref="P:ScintillaNET.StyleRun.Length"/> property of each run represents the number
of characters the run spans.
</param>
<exception cref="T:System.ArgumentNullException"><paramref name="styles"/> is null.</exception>
<remarks>
The <see cref="P:ScintillaNET.Annotation.Text"/> property must be set prior to styling and the sum length of
all runs should match the text length.
</remarks>
</member>
<member name="M:ScintillaNET.Annotation.op_Inequality(ScintillaNET.Annotation,ScintillaNET.Annotation)">
<summary>
Tests whether two <see cref="T:ScintillaNET.Annotation"/> object differ in location or content.
</summary>
<param name="left">The <see cref="T:ScintillaNET.Annotation"/> object that is to the left of the inequality operator.</param>
<param name="right">The <see cref="T:ScintillaNET.Annotation"/> object that is to the right of the inequality operator.</param>
<returns>true if the objects are considered unequal; otherwise, false.</returns>
</member>
<member name="M:ScintillaNET.Annotation.op_Equality(ScintillaNET.Annotation,ScintillaNET.Annotation)">
<summary>
Tests whether two <see cref="T:ScintillaNET.Annotation"/> objects have equal location and content.
</summary>
<param name="left">The <see cref="T:ScintillaNET.Annotation"/> object that is to the left of the equality operator.</param>
<param name="right">The <see cref="T:ScintillaNET.Annotation"/> object that is to the right of the equality operator.</param>
<returns>true if the objects are considered equal; otherwise, false.</returns>
</member>
<member name="M:ScintillaNET.Annotation.#ctor(ScintillaNET.Scintilla,System.Int32)">
<summary>
Initializes a new instance of the <see cref="T:ScintillaNET.Annotation"/> class.
</summary>
<param name="scintilla">The <see cref="T:ScintillaNET.Scintilla"/> control that created this object.</param>
<param name="lineIndex">The zero-based index of the document line containing the annotation.</param>
</member>
<member name="P:ScintillaNET.Annotation.LineCount">
<summary>
Gets the total number of text lines in the annotation.
</summary>
<remarks>An <see cref="T:System.Int32"/> representing the total number of text lines in the annotation.</remarks>
</member>
<member name="P:ScintillaNET.Annotation.LineIndex">
<summary>
Gets the index of the document line containing the annotation.
</summary>
<returns>
An <see cref="T:System.Int32"/> representing the zero-based index of the document line
containing the annotation, or -1 if the annotation has been rendered invalid
from a change in the <see cref="T:ScintillaNET.Scintilla"/> control that created it.
</returns>
</member>
<member name="P:ScintillaNET.Annotation.Style">
<summary>
Gets or sets the index of the style used to style the annotation text.
</summary>
<returns>
An <see cref="T:System.Int32"/> representing the zero-based index of the style used to style the annotation text,
or -1 if the annotation has individually style characters.
</returns>
</member>
<member name="P:ScintillaNET.Annotation.Text">
<summary>
Gets or sets the text of the annotation.
</summary>
<returns>A <see cref="T:System.String"/> representing the annotation text, or null if there is no annotation.</returns>
<remarks>
Only line feed characters ('\n') are recognized as line breaks.
All other control characters are not rendered.
</remarks>
</member>
<member name="T:ScintillaNET.AnnotationChangedEventArgs">
<summary>
Provides data for the <see cref="E:ScintillaNET.Scintilla.AnnotationChanged"/> event.
</summary>
</member>
<member name="M:ScintillaNET.AnnotationChangedEventArgs.#ctor(System.Int32,System.Int32)">
<summary>
Initializes a new instance of the <see cref="T:ScintillaNET.AnnotationChangedEventArgs"/> class.
</summary>
<param name="lineIndex">The document line index of the annotation that changed.</param>
<param name="lineCountDelta">The number of lines added to or removed from the annotation that changed.</param>
</member>
<member name="P:ScintillaNET.AnnotationChangedEventArgs.LineCountDelta">
<summary>
Gets the number of lines added to or removed from the changed annotation.
</summary>
<returns>
An <see cref="T:System.Int32"/> representing the number of lines added to or removed from the annotation.
Postive values indicate lines have been added; negative values indicate lines have been removed.
</returns>
</member>
<member name="P:ScintillaNET.AnnotationChangedEventArgs.LineIndex">
<summary>
Gets the index of the document line containing the changed annotation.
</summary>
<returns>The zero-based index of the document line containing the changed annotation.</returns>
</member>
<member name="T:ScintillaNET.AnnotationCollection">
<summary>
Represents a collection of <see cref="T:ScintillaNET.Annotation"/> objects and options in a <see cref="T:ScintillaNET.Scintilla"/> control.
</summary>
<remarks>
Annotations are customizable read-only blocks of text which can be displayed below
each line in a <see cref="T:ScintillaNET.Scintilla"/> control.
</remarks>
</member>
<member name="M:ScintillaNET.AnnotationCollection.ClearAll">
<summary>
Removes all annotations from the document.
</summary>
<remarks>This is equivalent to setting the <see cref="P:ScintillaNET.Annotation.Text"/> property to null for each line.</remarks>
</member>
<member name="M:ScintillaNET.AnnotationCollection.CreateAnnotationInstance(System.Int32)">
<summary>
Creates and returns a new <see cref="T:ScintillaNET.Annotation"/> object.
</summary>
<returns>A new <see cref="T:ScintillaNET.Annotation"/> object.</returns>
</member>
<member name="M:ScintillaNET.AnnotationCollection.GetEnumerator">
<summary>
Returns an enumerator for the <see cref="T:ScintillaNET.AnnotationCollection"/>.
</summary>
<returns>An <see cref="T:System.Collections.IEnumerator"/> for the <see cref="T:ScintillaNET.AnnotationCollection"/>.</returns>
</member>
<member name="M:ScintillaNET.AnnotationCollection.#ctor(ScintillaNET.Scintilla)">
<summary>
Initializes a new instance of the <see cref="T:ScintillaNET.AnnotationCollection"/> class.
</summary>
<param name="scintilla">The <see cref="T:ScintillaNET.Scintilla"/> control that created this object.</param>
</member>
<member name="P:ScintillaNET.AnnotationCollection.Count">
<summary>
Gets the number of annotations in the <see cref="T:ScintillaNET.AnnotationCollection"/>.
</summary>
<returns>The number of annotations contained in the <see cref="T:ScintillaNET.AnnotationCollection"/>.</returns>
<remarks>
As there can be one annotation per document line,
this is equivalent to the <see cref="P:ScintillaNET.LineCollection.Count"/> property.
</remarks>
</member>
<member name="P:ScintillaNET.AnnotationCollection.StyleOffset">
<summary>
Gets or sets the offset applied to style indexes used in annotations.
</summary>
<returns>The offset applied to style indexes used in annotations.</returns>
<remarks>
Annotation styles may be completely separated from standard text styles by setting a style offset.
For example, a value of 512 would shift the range of possible annotation styles to be from 512 to 767
so they do not overlap with standard text styles. This adjustment is applied automatically when setting
<see cref="P:ScintillaNET.Annotation.Style"/> or calling <see cref="M:ScintillaNET.Annotation.SetStyles(System.Collections.Generic.IEnumerable{ScintillaNET.StyleRun})"/> so the offset should NOT be
manually factored in by the caller. This property is provided to maintain architectural symmetry with
the native Scintilla component but is an advanced feature and typically should never need to be changed.
</remarks>
</member>
<member name="P:ScintillaNET.AnnotationCollection.Visibility">
<summary>
Gets or sets the visibility style for all annotations.
</summary>
<returns>
One of the <see cref="T:ScintillaNET.AnnotationsVisibility"/> values.
The default is <see cref="F:ScintillaNET.AnnotationsVisibility.Hidden"/>.
</returns>
<exception cref="T:System.ComponentModel.InvalidEnumArgumentException">
The value assigned is not one of the <see cref="T:ScintillaNET.AnnotationsVisibility"/> values.
</exception>
</member>
<member name="P:ScintillaNET.AnnotationCollection.Item(System.Int32)">
<summary>
Gets the annotation at the specified line index.
</summary>
<param name="lineIndex">The zero-based document line index of the annotation to get.</param>
<returns>The <see cref="T:ScintillaNET.Annotation"/> at the specified line index.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="lineIndex"/> is less than zero. -or-
<paramref name="lineIndex"/> is equal to or greater than <see cref="P:ScintillaNET.AnnotationCollection.Count"/>.
</exception>
</member>
<member name="T:ScintillaNET.AnnotationsVisibility">
<summary>
Specifies the visibility and appearance of annotations in a <see cref="T:ScintillaNET.Scintilla"/> control.
</summary>
</member>
<member name="F:ScintillaNET.AnnotationsVisibility.Hidden">
<summary>
Annotations are not displayed.
</summary>
</member>
<member name="F:ScintillaNET.AnnotationsVisibility.Standard">
<summary>
Annotations are drawn left-justified with no adorment.
</summary>
</member>
<member name="F:ScintillaNET.AnnotationsVisibility.Boxed">
<summary>
Annotations are indented to match the text and are surrounded by a box.
</summary>
</member>
<member name="T:ScintillaNET.AutoComplete">
<summary>
Used to invoke AutoComplete and UserList windows. Also manages AutoComplete
settings.
</summary>
<remarks>
Autocomplete is typically used in IDEs to automatically complete some kind
of identifier or keyword based on a partial name.
</remarks>
</member>
<member name="T:ScintillaNET.TopLevelHelper">
<summary>
Top level ScintillaHelpers Like Style and Folding inherit from this class so they don't have
to reimplement the same Equals method
</summary>
</member>
<member name="M:ScintillaNET.ScintillaHelperBase.Equals(System.Object)">
<summary>
Abstract Equals Override. All Helpers must implement this. Use IsSameHelperFamily to
determine if the types are compatible and they have the same Scintilla. For most top
level helpers like Caret and Lexing this should be enough. Helpers like Marker and
Line also need to take other variables into consideration.
</summary>
<param name="obj"></param>
<returns></returns>
</member>
<member name="M:ScintillaNET.ScintillaHelperBase.IsSameHelperFamily(System.Object)">
<summary>
Determines if obj belongs to the same Scintilla and is of compatible type
</summary>
</member>
<member name="M:ScintillaNET.AutoComplete.Accept">
<summary>
Accepts the current AutoComplete window entry
</summary>
<remarks>
If the AutoComplete window is open Accept() will close it. This also causes the
<see cref="E:ScintillaNET.Scintilla.AutoCompleteAccepted"/> event to fire
</remarks>
</member>
<member name="M:ScintillaNET.AutoComplete.Cancel">
<summary>
Cancels the autocomplete window
</summary>
<remarks>
If the AutoComplete window is displayed calling Cancel() will close the window.
</remarks>
</member>
<member name="M:ScintillaNET.AutoComplete.ClearRegisteredImages">
<summary>
Deletes all registered images.
</summary>
</member>
<member name="M:ScintillaNET.AutoComplete.RegisterImage(System.Int32,System.Drawing.Bitmap)">
<summary>
Registers an image with index to be displayed in the AutoComplete window.
</summary>
<param name="type">Index of the image to register to</param>
<param name="image">Image to display in Bitmap format</param>
</member>
<member name="M:ScintillaNET.AutoComplete.RegisterImage(System.Int32,System.Drawing.Bitmap,System.Drawing.Color)">
<summary>
Registers an image with index to be displayed in the AutoComplete window.
</summary>
<param name="type">Index of the image to register to</param>
<param name="xpmImage">Image to display in the XPM image format</param>
<param name="transparentColor">Color to mask the image as transparent</param>
</member>
<member name="M:ScintillaNET.AutoComplete.RegisterImage(System.Int32,System.String)">
<summary>
Registers an image with index to be displayed in the AutoComplete window.
</summary>
<param name="type">Index of the image to register to</param>
<param name="xpmImage">Image in the XPM image format</param>
</member>
<member name="M:ScintillaNET.AutoComplete.RegisterImages(System.Collections.Generic.IList{System.Drawing.Bitmap})">
<summary>
Registers a list of images to be displayed in the AutoComplete window.
</summary>
<param name="images">List of images in the Bitmap image format</param>
<remarks>Indecis are assigned sequentially starting at 0</remarks>
</member>
<member name="M:ScintillaNET.AutoComplete.RegisterImages(System.Collections.Generic.IList{System.Drawing.Bitmap},System.Drawing.Color)">
<summary>
Registers a list of images to be displayed in the AutoComplete window.
</summary>
<param name="images">List of images in the Bitmap image format</param>
<param name="transparentColor">Color to mask the image as transparent</param>
<remarks>Indecis are assigned sequentially starting at 0</remarks>
</member>
<member name="M:ScintillaNET.AutoComplete.RegisterImages(System.Collections.Generic.IList{System.String})">
<summary>
Registers a list of images to be displayed in the AutoComplete window.
</summary>
<param name="xpmImages">List of images in the XPM image format</param>
<remarks>Indecis are assigned sequentially starting at 0</remarks>
</member>
<member name="M:ScintillaNET.AutoComplete.RegisterImages(System.Windows.Forms.ImageList)">
<summary>
Registers a list of images to be displayed in the AutoComplete window.
</summary>
<param name="images">List of images contained in an ImageList</param>
<remarks>Indecis are assigned sequentially starting at 0</remarks>
</member>
<member name="M:ScintillaNET.AutoComplete.RegisterImages(System.Windows.Forms.ImageList,System.Drawing.Color)">
<summary>
Registers a list of images to be displayed in the AutoComplete window.
</summary>
<param name="images">List of images contained in an ImageList</param>
<param name="transparentColor">Color to mask the image as transparent</param>
<remarks>Indecis are assigned sequentially starting at 0</remarks>
</member>
<member name="M:ScintillaNET.AutoComplete.Show">
<summary>
Shows the autocomplete window.
</summary>
<remarks>
This overload assumes that the <see cref="P:ScintillaNET.AutoComplete.List"/> property has been
set. The lengthEntered is automatically detected by the editor.
</remarks>
</member>
<member name="M:ScintillaNET.AutoComplete.Show(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Shows the autocomplete window
</summary>
<param name="list">
Sets the <see cref="P:ScintillaNET.AutoComplete.List"/> property.
In this overload the lengthEntered is automatically detected by the editor.
</param>
</member>
<member name="M:ScintillaNET.AutoComplete.Show(System.Int32)">
<summary>
Shows the autocomplete window
</summary>
<param name="lengthEntered">Number of characters of the current word already entered in the editor </param>
<remarks>
This overload assumes that the <see cref="P:ScintillaNET.AutoComplete.List"/> property has been set.
</remarks>
</member>
<member name="M:ScintillaNET.AutoComplete.Show(System.Int32,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Shows the autocomplete window
</summary>
<param name="lengthEntered">Number of characters of the current word already entered in the editor </param>
<param name="list">Sets the <see cref="P:ScintillaNET.AutoComplete.List"/> property. </param>
</member>
<member name="M:ScintillaNET.AutoComplete.Show(System.Int32,System.String)">
<summary>
Shows the autocomplete window.
</summary>
<param name="lengthEntered">Number of characters of the current word already entered in the editor </param>
<param name="list">Sets the <see cref="P:ScintillaNET.AutoComplete.ListString"/> property. </param>
</member>
<member name="M:ScintillaNET.AutoComplete.Show(System.String)">
<summary>
Shows the autocomplete window.
</summary>
<param name="list">Sets the <see cref="P:ScintillaNET.AutoComplete.ListString"/> property. </param>
<remarks>
In this overload the lengthEntered is automatically detected by the editor.
</remarks>
</member>
<member name="M:ScintillaNET.AutoComplete.ShowUserList(System.Int32,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Shows a UserList window
</summary>
<param name="listType">Index of the userlist to show. Can be any integer</param>
<param name="list">List of words to show.</param>
<remarks>
UserLists are not as powerful as autocomplete but can be assigned to a user defined index.
</remarks>
</member>
<member name="M:ScintillaNET.AutoComplete.ShowUserList(System.Int32,System.String)">
<summary>
Shows a UserList window
</summary>
<param name="listType">Index of the userlist to show. Can be any integer</param>
<param name="list">List of words to show separated by " "</param>
<remarks>
UserLists are not as powerful as autocomplete but can be assigned to a user defined index.
</remarks>
</member>
<member name="P:ScintillaNET.AutoComplete.AutoHide">
<summary>
By default, the list is cancelled if there are no viable matches (the user has typed characters that no longer match a list entry).
If you want to keep displaying the original list, set AutoHide to false.
</summary>
</member>
<member name="P:ScintillaNET.AutoComplete.AutomaticLengthEntered">
<summary>
Gets or Sets the last automatically calculated LengthEntered used whith <see cref="M:ScintillaNET.AutoComplete.Show"/>.
</summary>
</member>
<member name="P:ScintillaNET.AutoComplete.CancelAtStart">
<summary>
The default behavior is for the list to be cancelled if the caret moves before the location it was at when the list was displayed.
By setting this property to false, the list is not cancelled until the caret moves before the first character of the word being completed.
</summary>
</member>
<member name="P:ScintillaNET.AutoComplete.DropRestOfWord">
<summary>
When an item is selected, any word characters following the caret are first erased if dropRestOfWord is set to true.
</summary>
<remarks>Defaults to false</remarks>
</member>
<member name="P:ScintillaNET.AutoComplete.FillUpCharacters">
<summary>
List of characters (no separated) that causes the AutoComplete window to accept the current
selection.
</summary>
</member>
<member name="P:ScintillaNET.AutoComplete.ImageSeparator">
<summary>
Autocompletion list items may display an image as well as text. Each image is first registered with an integer type.
Then this integer is included in the text of the list separated by a '?' from the text. For example, "fclose?2 fopen"
displays image 2 before the string "fclose" and no image before "fopen".
</summary>
</member>
<member name="P:ScintillaNET.AutoComplete.IsActive">
<summary>
Returns wether or not the AutoComplete window is currently displayed
</summary>
</member>
<member name="P:ScintillaNET.AutoComplete.IsCaseSensitive">
<summary>
Gets or Sets if the comparison of words to the AutoComplete <see cref="P:ScintillaNET.AutoComplete.List"/> are case sensitive.
</summary>
<remarks>Defaults to true</remarks>
</member>
<member name="P:ScintillaNET.AutoComplete.LastStartPosition">
<summary>
Gets the document posision when the AutoComplete window was last invoked
</summary>
</member>
<member name="P:ScintillaNET.AutoComplete.List">
<summary>
List if words to display in the AutoComplete window when invoked.
</summary>
</member>
<member name="P:ScintillaNET.AutoComplete.ListSeparator">
<summary>
Character used to split <see cref="P:ScintillaNET.AutoComplete.ListString"/> to convert to a List.
</summary>
</member>
<member name="P:ScintillaNET.AutoComplete.ListString">
<summary>
List of words to display in the AutoComplete window.
</summary>
<remarks>
The list of words separated by <see cref="P:ScintillaNET.AutoComplete.ListSeparator"/> which
is " " by default.
</remarks>
</member>
<member name="P:ScintillaNET.AutoComplete.MaxHeight">
<summary>
Get or set the maximum number of rows that will be visible in an autocompletion list. If there are more rows in the list, then a vertical scrollbar is shown
</summary>
<remarks>Defaults to 5</remarks>
</member>
<member name="P:ScintillaNET.AutoComplete.MaxWidth">
<summary>
Get or set the maximum width of an autocompletion list expressed as the number of characters in the longest item that will be totally visible.
</summary>
<remarks>
If zero (the default) then the list's width is calculated to fit the item with the most characters. Any items that cannot be fully displayed
within the available width are indicated by the presence of ellipsis.
</remarks>
</member>
<member name="P:ScintillaNET.AutoComplete.SelectedIndex">
<summary>
Gets or Sets the index of the currently selected item in the AutoComplete <see cref="P:ScintillaNET.AutoComplete.List"/>
</summary>
</member>
<member name="P:ScintillaNET.AutoComplete.SelectedText">
<summary>
Gets or Sets the Text of the currently selected AutoComplete item.
</summary>
<remarks>
When setting this property it does not change the text of the currently
selected item. Instead it searches the list for the given value and selects
that item if it matches.
</remarks>
</member>
<member name="P:ScintillaNET.AutoComplete.SingleLineAccept">
<summary>
If you set this value to true and a list has only one item, it is automatically added and no list is displayed.
The default is to display the list even if there is only a single item.
</summary>
</member>
<member name="P:ScintillaNET.AutoComplete.StopCharacters">
<summary>
List of characters (no separator) that causes the AutoComplete window to cancel.
</summary>
</member>
<member name="T:ScintillaNET.AutoCompleteAcceptedEventArgs">
<summary>
Provides data for the AutoCompleteAccepted event
</summary>
</member>
<member name="M:ScintillaNET.AutoCompleteAcceptedEventArgs.#ctor(System.String)">
<summary>
Initializes a new instance of the AutoCompleteAcceptedEventArgs class.
</summary>
<param name="text">Text of the selected autocomplete entry selected</param>
</member>
<member name="P:ScintillaNET.AutoCompleteAcceptedEventArgs.Cancel">
<summary>
Gets/Sets if the autocomplete action should be cancelled
</summary>
</member>
<member name="P:ScintillaNET.AutoCompleteAcceptedEventArgs.Text">
<summary>
Text of the selected autocomplete entry selected
</summary>
</member>
<member name="P:ScintillaNET.AutoCompleteAcceptedEventArgs.WordStartPosition">
<summary>
Returns the _start position of the current word in the document.
</summary>
<remarks>
This controls how many characters of the selected autocomplete entry
is actually inserted into the document
</remarks>
</member>
<member name="T:ScintillaNET.BindableCommand">
<summary>
List of commands that ScintillaNET can execute. These can be
bound to keyboard shortcuts
</summary>
</member>
<member name="T:ScintillaNET.CallTip">
<summary>
Used to display CallTips and Manages CallTip settings.
</summary>
<remarks>
CallTips are a special form of ToolTip that can be displayed specifically for
a document position. It also display a list of method overloads and
highlighight a portion of the message. This is useful in IDE scenarios.
</remarks>
</member>
<member name="M:ScintillaNET.CallTip.Cancel">
<summary>
Hides the calltip
</summary>
<remarks>
<see cref="M:ScintillaNET.CallTip.Hide"/> and <see cref="M:ScintillaNET.CallTip.Cancel"/> do the same thing
</remarks>
</member>
<member name="M:ScintillaNET.CallTip.Hide">
<summary>
Hides the calltip
</summary>
<remarks>
<see cref="M:ScintillaNET.CallTip.Hide"/> and <see cref="M:ScintillaNET.CallTip.Cancel"/> do the same thing
</remarks>
</member>
<member name="M:ScintillaNET.CallTip.Show">
<summary>
Displays a calltip without overloads
</summary>
<remarks>
The <see cref="P:ScintillaNET.CallTip.Message"/> must already be populated. The calltip will be displayed at the current document position
with no highlight.
</remarks>
</member>
<member name="M:ScintillaNET.CallTip.Show(System.Int32,System.Int32)">
<summary>
Displays a calltip without overloads
</summary>
<param name="highlightStart">Start posision of the part of the message that should be selected</param>
<param name="highlightEnd">End posision of the part of the message that should be selected</param>
<remarks>
The <see cref="P:ScintillaNET.CallTip.Message"/> must already be populated. The calltip will be displayed at the current document position
</remarks>
</member>
<member name="M:ScintillaNET.CallTip.Show(System.Int32)">
<summary>
Displays a calltip without overloads
</summary>
<param name="position">The document position to show the calltip</param>
<remarks>
The <see cref="P:ScintillaNET.CallTip.Message"/> must already be populated. The calltip with no highlight
</remarks>
</member>
<member name="M:ScintillaNET.CallTip.Show(System.Int32,System.Int32,System.Int32)">
<summary>
Displays a calltip without overloads
</summary>
<param name="position">The document position to show the calltip</param>
<param name="highlightStart">Start posision of the part of the message that should be selected</param>
<param name="highlightEnd">End posision of the part of the message that should be selected</param>
<remarks>
The <see cref="P:ScintillaNET.CallTip.Message"/> must already be populated.
</remarks>
</member>
<member name="M:ScintillaNET.CallTip.Show(System.String)">
<summary>
Displays a calltip without overloads
</summary>
<param name="message">The calltip message to be displayed</param>
<remarks>
The calltip will be displayed at the current document position with no highlight
</remarks>
</member>
<member name="M:ScintillaNET.CallTip.Show(System.String,System.Int32,System.Int32)">
<summary>
Displays a calltip without overloads
</summary>
<param name="message">The calltip message to be displayed</param>
<param name="highlightStart">Start posision of the part of the message that should be selected</param>
<param name="highlightEnd">End posision of the part of the message that should be selected</param>
<remarks>
The calltip will be displayed at the current document position
</remarks>
</member>
<member name="M:ScintillaNET.CallTip.Show(System.String,System.Int32)">
<summary>
Displays a calltip without overloads
</summary>
<param name="message">The calltip message to be displayed</param>
<param name="position">The document position to show the calltip</param>
<remarks>
The calltip will be displayed with no highlight
</remarks>
</member>
<member name="M:ScintillaNET.CallTip.Show(System.String,System.Int32,System.Int32,System.Int32)">
<summary>
Displays a calltip without overloads
</summary>
<param name="message">The calltip message to be displayed</param>
<param name="position">The document position to show the calltip</param>
<param name="highlightStart">Start posision of the part of the message that should be selected</param>
<param name="highlightEnd">End posision of the part of the message that should be selected</param>
</member>
<member name="M:ScintillaNET.CallTip.ShowOverload">
<summary>
Shows the calltip with overloads
</summary>
<remarks>
ShowOverload automatically handles displaying a calltip with a list of overloads. It automatically shows the
up and down arrows and cycles through the list of overloads in response to mouse clicks.
The <see cref="!:OverLoadList"/> must already be populated. It will be displayed at the current document
position starting at overload 0 with no highlight.
</remarks>
</member>
<member name="M:ScintillaNET.CallTip.ShowOverload(System.Int32,System.Int32)">
<summary>
Shows the calltip with overloads
</summary>
<param name="highlightStart">Start posision of the part of the message that should be selected</param>
<param name="highlightEnd">End posision of the part of the message that should be selected</param>
<remarks>
ShowOverload automatically handles displaying a calltip with a list of overloads. It automatically shows the
up and down arrows and cycles through the list of overloads in response to mouse clicks.
The <see cref="!:OverLoadList"/> must already be populated. It will be displayed at the current document
position starting at overload 0
</remarks>
</member>
<member name="M:ScintillaNET.CallTip.ShowOverload(System.Int32)">
<summary>
Shows the calltip with overloads
</summary>
<param name="position">The document position where the calltip should be displayed</param>
<remarks>
ShowOverload automatically handles displaying a calltip with a list of overloads. It automatically shows the
up and down arrows and cycles through the list of overloads in response to mouse clicks.
The <see cref="!:OverLoadList"/> must already be populated. The overload at position 0 will be displayed
with no highlight.
</remarks>
</member>
<member name="M:ScintillaNET.CallTip.ShowOverload(System.Int32,System.Int32,System.Int32)">
<summary>
Shows the calltip with overloads
</summary>
<param name="position">The document position where the calltip should be displayed</param>
<param name="highlightStart">Start posision of the part of the message that should be selected</param>
<param name="highlightEnd">End posision of the part of the message that should be selected</param>
<remarks>
ShowOverload automatically handles displaying a calltip with a list of overloads. It automatically shows the
up and down arrows and cycles through the list of overloads in response to mouse clicks.
The <see cref="!:OverLoadList"/> must already be populated. The overload at position 0 will be displayed.
</remarks>
</member>
<member name="M:ScintillaNET.CallTip.ShowOverload(System.Int32,System.UInt32)">
<summary>
Shows the calltip with overloads
</summary>
<param name="position">The document position where the calltip should be displayed</param>
<param name="startIndex">The index of the initial overload to display</param>
<remarks>
ShowOverload automatically handles displaying a calltip with a list of overloads. It automatically shows the
up and down arrows and cycles through the list of overloads in response to mouse clicks.
The <see cref="!:OverLoadList"/> must already be populated. It will be displayed at the current document
position with no highlight
</remarks>
</member>
<member name="M:ScintillaNET.CallTip.ShowOverload(System.Int32,System.UInt32,System.Int32,System.Int32)">
<summary>
Shows the calltip with overloads
</summary>
<param name="position">The document position where the calltip should be displayed</param>
<param name="startIndex">The index of the initial overload to display</param>
<param name="highlightStart">Start posision of the part of the message that should be selected</param>
<param name="highlightEnd">End posision of the part of the message that should be selected</param>
<remarks>
ShowOverload automatically handles displaying a calltip with a list of overloads. It automatically shows the
up and down arrows and cycles through the list of overloads in response to mouse clicks.
The <see cref="!:OverLoadList"/> must already be populated.
</remarks>
</member>
<member name="M:ScintillaNET.CallTip.ShowOverload(ScintillaNET.OverloadList)">
<summary>
Shows the calltip with overloads
</summary>
<param name="overloadList">List of overloads to be displayed see <see cref="!:OverLoadList"/></param>
<remarks>
ShowOverload automatically handles displaying a calltip with a list of overloads. It automatically shows the
up and down arrows and cycles through the list of overloads in response to mouse clicks.
The current document position will be used starting at position 0 with no highlight
</remarks>
</member>
<member name="M:ScintillaNET.CallTip.ShowOverload(ScintillaNET.OverloadList,System.Int32,System.Int32)">
<summary>
Shows the calltip with overloads
</summary>
<param name="overloadList">List of overloads to be displayed see <see cref="!:OverLoadList"/></param>
<param name="highlightStart">Start posision of the part of the message that should be selected</param>
<param name="highlightEnd">End posision of the part of the message that should be selected</param>
<remarks>
ShowOverload automatically handles displaying a calltip with a list of overloads. It automatically shows the
up and down arrows and cycles through the list of overloads in response to mouse clicks.
The current document position will be used starting at position 0
</remarks>
</member>
<member name="M:ScintillaNET.CallTip.ShowOverload(ScintillaNET.OverloadList,System.Int32)">
<summary>
Shows the calltip with overloads
</summary>
<param name="overloadList">List of overloads to be displayed see <see cref="!:OverLoadList"/></param>
<param name="position">The document position where the calltip should be displayed</param>
<remarks>
ShowOverload automatically handles displaying a calltip with a list of overloads. It automatically shows the
up and down arrows and cycles through the list of overloads in response to mouse clicks.
The overload startIndex will be 0 with no Highlight
</remarks>
</member>
<member name="M:ScintillaNET.CallTip.ShowOverload(ScintillaNET.OverloadList,System.Int32,System.Int32,System.Int32)">
<summary>
Shows the calltip with overloads
</summary>
<param name="overloadList">List of overloads to be displayed see <see cref="!:OverLoadList"/></param>
<param name="position">The document position where the calltip should be displayed</param>
<param name="highlightStart">Start posision of the part of the message that should be selected</param>
<param name="highlightEnd">End posision of the part of the message that should be selected</param>
<remarks>
ShowOverload automatically handles displaying a calltip with a list of overloads. It automatically shows the
up and down arrows and cycles through the list of overloads in response to mouse clicks.
The overload startIndex will be 0
</remarks>
</member>
<member name="M:ScintillaNET.CallTip.ShowOverload(ScintillaNET.OverloadList,System.Int32,System.UInt32,System.Int32,System.Int32)">
<summary>
Shows the calltip with overloads
</summary>
<param name="overloadList">List of overloads to be displayed see <see cref="!:OverLoadList"/></param>
<param name="position">The document position where the calltip should be displayed</param>
<param name="startIndex">The index of the initial overload to display</param>
<param name="highlightStart">Start posision of the part of the message that should be selected</param>
<param name="highlightEnd">End posision of the part of the message that should be selected</param>
<remarks>
ShowOverload automatically handles displaying a calltip with a list of overloads. It automatically shows the
up and down arrows and cycles through the list of overloads in response to mouse clicks.
</remarks>
</member>
<member name="M:ScintillaNET.CallTip.ShowOverload(ScintillaNET.OverloadList,System.UInt32)">
<summary>
Shows the calltip with overloads
</summary>
<param name="overloadList">List of overloads to be displayed see <see cref="!:OverLoadList"/></param>
<param name="startIndex">The index of the initial overload to display</param>
<remarks>
ShowOverload automatically handles displaying a calltip with a list of overloads. It automatically shows the
up and down arrows and cycles through the list of overloads in response to mouse clicks.
The current document position will be used with no highlight
</remarks>
</member>
<member name="M:ScintillaNET.CallTip.ShowOverload(ScintillaNET.OverloadList,System.UInt32,System.Int32,System.Int32)">
<summary>
Shows the calltip with overloads
</summary>
<param name="overloadList">List of overloads to be displayed see <see cref="!:OverLoadList"/></param>
<param name="startIndex">The index of the initial overload to display</param>
<param name="highlightStart">Start posision of the part of the message that should be selected</param>
<param name="highlightEnd">End posision of the part of the message that should be selected</param>
<remarks>
ShowOverload automatically handles displaying a calltip with a list of overloads. It automatically shows the
up and down arrows and cycles through the list of overloads in response to mouse clicks.
The current document position will be used
</remarks>
</member>
<member name="M:ScintillaNET.CallTip.ShowOverload(System.UInt32)">
<summary>
Shows the calltip with overloads
</summary>
<param name="startIndex">The index of the initial overload to display</param>
<remarks>
ShowOverload automatically handles displaying a calltip with a list of overloads. It automatically shows the
up and down arrows and cycles through the list of overloads in response to mouse clicks.
The <see cref="!:OverLoadList"/> must already be populated. It will be displayed at the current document
position with no highlight.
</remarks>
</member>
<member name="M:ScintillaNET.CallTip.ShowOverload(System.UInt32,System.Int32,System.Int32)">
<summary>
Shows the calltip with overloads
</summary>
<param name="startIndex">The index of the initial overload to display</param>
<param name="highlightStart">Start posision of the part of the message that should be selected</param>
<param name="highlightEnd">End posision of the part of the message that should be selected</param>
<remarks>
ShowOverload automatically handles displaying a calltip with a list of overloads. It automatically shows the
up and down arrows and cycles through the list of overloads in response to mouse clicks.
The <see cref="!:OverLoadList"/> must already be populated. It will be displayed at the current document
position.
</remarks>
</member>
<member name="P:ScintillaNET.CallTip.BackColor">
<summary>
Gets/Sets the background color of all CallTips
</summary>
</member>
<member name="P:ScintillaNET.CallTip.ForeColor">
<summary>
Gets/Sets Text color of all CallTips
</summary>
</member>
<member name="P:ScintillaNET.CallTip.HighlightEnd">
<summary>
End position of the text to be highlighted in the CalTip
</summary>
</member>
<member name="P:ScintillaNET.CallTip.HighlightStart">
<summary>
Start position of the text to be highlighted in the CalTip
</summary>
</member>
<member name="P:ScintillaNET.CallTip.HighlightTextColor">
<summary>
Gets/Sets the Text Color of the portion of the CallTip that is highlighted
</summary>
</member>
<member name="P:ScintillaNET.CallTip.IsActive">
<summary>
Returns true if a CallTip is currently displayed
</summary>
</member>
<member name="P:ScintillaNET.CallTip.Message">
<summary>
The message displayed in the calltip
</summary>
</member>
<member name="P:ScintillaNET.CallTip.OverloadList">
<summary>
List of method overloads to display in the calltip
</summary>
<remarks>
This is used to display IDE type toolips that include Up/Down arrows that cycle
through the list of overloads when clicked
</remarks>
</member>
<member name="T:ScintillaNET.CallTipArrow">
<summary>
Represents an arrow in the CallTip
</summary>
</member>
<member name="F:ScintillaNET.CallTipArrow.None">
<summary>
No arrow
</summary>
</member>
<member name="F:ScintillaNET.CallTipArrow.Up">
<summary>
The Up arrow
</summary>
</member>
<member name="F:ScintillaNET.CallTipArrow.Down">
<summary>
The Down Arrow
</summary>
</member>
<member name="T:ScintillaNET.CallTipClickEventArgs">
<summary>
Provides data for the CallTipClick event
</summary>
</member>
<member name="M:ScintillaNET.CallTipClickEventArgs.#ctor(ScintillaNET.CallTipArrow,System.Int32,System.Int32,ScintillaNET.OverloadList,System.Int32,System.Int32)">
<summary>
Initializes a new instance of the CallTipClickEventArgs class.
</summary>
<param name="callTipArrow">CallTipArrow clicked</param>
<param name="currentIndex">Current posision of the overload list</param>
<param name="newIndex">New position of the overload list</param>
<param name="overloadList">List of overloads to be cycled in the calltip</param>
<param name="highlightStart">Start position of the highlighted text</param>
<param name="highlightEnd">End position of the highlighted text</param>
</member>
<member name="P:ScintillaNET.CallTipClickEventArgs.CallTipArrow">
<summary>
Returns the CallTipArrow that was clicked
</summary>
</member>
<member name="P:ScintillaNET.CallTipClickEventArgs.Cancel">
<summary>
Gets/Sets if the CallTip should be hidden
</summary>
</member>
<member name="P:ScintillaNET.CallTipClickEventArgs.CurrentIndex">
<summary>
Gets the current index of the CallTip's overload list
</summary>
</member>
<member name="P:ScintillaNET.CallTipClickEventArgs.HighlightEnd">
<summary>
Gets/Sets the _end position of the CallTip's highlighted portion of text
</summary>
</member>
<member name="P:ScintillaNET.CallTipClickEventArgs.HighlightStart">
<summary>
Gets/Sets the _start position of the CallTip's highlighted portion of text
</summary>
</member>
<member name="P:ScintillaNET.CallTipClickEventArgs.NewIndex">
<summary>
Gets/Sets the new index of the CallTip's overload list
</summary>
</member>
<member name="P:ScintillaNET.CallTipClickEventArgs.OverloadList">
<summary>
Returns the OverLoad list of the CallTip
</summary>
</member>
<member name="T:ScintillaNET.CaretInfo">
<summary>
Manages Caret Settings
</summary>
<remarks>
The caret is the blinking line that indicates the current document position. This