C# Class ARCed.Scintilla.AutoComplete

Inheritance: TopLevelHelper
Show file Open project: borisblizzard/arcreator

Private Properties

Property Type Description
AutoComplete System.Collections.Generic
GetLengthEntered int
GetListString string
RegisterImage void
RegisterImage void
ResetAutoHide void
ResetAutomaticLengthEntered void
ResetCancelAtStart void
ResetDropRestOfWord void
ResetFillUpCharacters void
ResetImageSeparator void
ResetIsCaseSensitive void
ResetListSeparator void
ResetMaxHeight void
ResetMaxWidth void
ResetSingleLineAccept void
ResetStopCharacters void
ShouldSerialize bool
ShouldSerializeAutoHide bool
ShouldSerializeAutomaticLengthEntered bool
ShouldSerializeCancelAtStart bool
ShouldSerializeDropRestOfWord bool
ShouldSerializeFillUpCharacters bool
ShouldSerializeImageSeparator bool
ShouldSerializeIsCaseSensitive bool
ShouldSerializeListSeparator bool
ShouldSerializeMaxHeight bool
ShouldSerializeMaxWidth bool
ShouldSerializeSingleLineAccept bool
ShouldSerializeStopCharacters bool
Show void

Public Methods

Method Description
Accept ( ) : void

Accepts the current AutoComplete window entry

If the AutoComplete window is open Accept() will close it. This also causes the Scintilla.AutoCompleteAccepted event to fire

Cancel ( ) : void

Cancels the autocomplete window

If the AutoComplete window is displayed calling Cancel() will close the window.

ClearRegisteredImages ( ) : void

Deletes all registered images.

RegisterImage ( int type, string xpmImage ) : void

Registers an _srcTexture with index to be displayed in the AutoComplete window.

RegisterImages ( IList images ) : void

Registers a list of images to be displayed in the AutoComplete window.

Indecis are assigned sequentially starting at 0

RegisterImages ( IList images, Color transparentColor ) : void

Registers a list of images to be displayed in the AutoComplete window.

Indecis are assigned sequentially starting at 0

RegisterImages ( IList xpmImages ) : void

Registers a list of images to be displayed in the AutoComplete window.

Indecis are assigned sequentially starting at 0

RegisterImages ( ImageList images ) : void

Registers a list of images to be displayed in the AutoComplete window.

Indecis are assigned sequentially starting at 0

RegisterImages ( ImageList images, Color transparentColor ) : void

Registers a list of images to be displayed in the AutoComplete window.

Indecis are assigned sequentially starting at 0

Show ( ) : void

Shows the autocomplete window.

This overload assumes that the List property has been set. The lengthEntered is automatically detected by the editor.

Show ( IEnumerable list ) : void

Shows the autocomplete window

Show ( int lengthEntered ) : void

Shows the autocomplete window

This overload assumes that the List property has been set.

Show ( int lengthEntered, IEnumerable list ) : void

Shows the autocomplete window

Show ( int lengthEntered, string list ) : void

Shows the autocomplete window.

Show ( string list ) : void

Shows the autocomplete window.

In this overload the lengthEntered is automatically detected by the editor.

ShowUserList ( int listType, IEnumerable list ) : void

Shows a UserList window

UserLists are not as powerful as autocomplete but can be assigned to a user defined index.

ShowUserList ( int listType, string list ) : void

Shows a UserList window

UserLists are not as powerful as autocomplete but can be assigned to a user defined index.

Private Methods

Method Description
AutoComplete ( Scintilla scintilla ) : System.Collections.Generic
GetLengthEntered ( ) : int
GetListString ( IEnumerable list ) : string
RegisterImage ( int type, Bitmap image ) : void

Registers an _srcTexture with index to be displayed in the AutoComplete window.

RegisterImage ( int type, Bitmap image, Color transparentColor ) : void

Registers an _srcTexture with index to be displayed in the AutoComplete window.

ResetAutoHide ( ) : void
ResetAutomaticLengthEntered ( ) : void
ResetCancelAtStart ( ) : void
ResetDropRestOfWord ( ) : void
ResetFillUpCharacters ( ) : void
ResetImageSeparator ( ) : void
ResetIsCaseSensitive ( ) : void
ResetListSeparator ( ) : void
ResetMaxHeight ( ) : void
ResetMaxWidth ( ) : void
ResetSingleLineAccept ( ) : void
ResetStopCharacters ( ) : void
ShouldSerialize ( ) : bool
ShouldSerializeAutoHide ( ) : bool
ShouldSerializeAutomaticLengthEntered ( ) : bool
ShouldSerializeCancelAtStart ( ) : bool
ShouldSerializeDropRestOfWord ( ) : bool
ShouldSerializeFillUpCharacters ( ) : bool
ShouldSerializeImageSeparator ( ) : bool
ShouldSerializeIsCaseSensitive ( ) : bool
ShouldSerializeListSeparator ( ) : bool
ShouldSerializeMaxHeight ( ) : bool
ShouldSerializeMaxWidth ( ) : bool
ShouldSerializeSingleLineAccept ( ) : bool
ShouldSerializeStopCharacters ( ) : bool
Show ( int lengthEntered, string list, bool dontSplit ) : void

Method Details

Accept() public method

Accepts the current AutoComplete window entry
If the AutoComplete window is open Accept() will close it. This also causes the Scintilla.AutoCompleteAccepted event to fire
public Accept ( ) : void
return void

Cancel() public method

Cancels the autocomplete window
If the AutoComplete window is displayed calling Cancel() will close the window.
public Cancel ( ) : void
return void

ClearRegisteredImages() public method

Deletes all registered images.
public ClearRegisteredImages ( ) : void
return void

RegisterImage() public method

Registers an _srcTexture with index to be displayed in the AutoComplete window.
public RegisterImage ( int type, string xpmImage ) : void
type int Index of the _srcTexture to register to
xpmImage string Image in the XPM _srcTexture format
return void

RegisterImages() public method

Registers a list of images to be displayed in the AutoComplete window.
Indecis are assigned sequentially starting at 0
public RegisterImages ( IList images ) : void
images IList List of images in the Bitmap _srcTexture format
return void

RegisterImages() public method

Registers a list of images to be displayed in the AutoComplete window.
Indecis are assigned sequentially starting at 0
public RegisterImages ( IList images, Color transparentColor ) : void
images IList List of images in the Bitmap _srcTexture format
transparentColor System.Drawing.Color Color to mask the _srcTexture as transparent
return void

RegisterImages() public method

Registers a list of images to be displayed in the AutoComplete window.
Indecis are assigned sequentially starting at 0
public RegisterImages ( IList xpmImages ) : void
xpmImages IList List of images in the XPM _srcTexture format
return void

RegisterImages() public method

Registers a list of images to be displayed in the AutoComplete window.
Indecis are assigned sequentially starting at 0
public RegisterImages ( ImageList images ) : void
images System.Windows.Forms.ImageList List of images contained in an ImageList
return void

RegisterImages() public method

Registers a list of images to be displayed in the AutoComplete window.
Indecis are assigned sequentially starting at 0
public RegisterImages ( ImageList images, Color transparentColor ) : void
images System.Windows.Forms.ImageList List of images contained in an ImageList
transparentColor System.Drawing.Color Color to mask the _srcTexture as transparent
return void

Show() public method

Shows the autocomplete window.
This overload assumes that the List property has been set. The lengthEntered is automatically detected by the editor.
public Show ( ) : void
return void

Show() public method

Shows the autocomplete window
public Show ( IEnumerable list ) : void
list IEnumerable /// Sets the property. /// In this overload the lengthEntered is automatically detected by the editor. ///
return void

Show() public method

Shows the autocomplete window
This overload assumes that the List property has been set.
public Show ( int lengthEntered ) : void
lengthEntered int Number of characters of the current word already entered in the editor
return void

Show() public method

Shows the autocomplete window
public Show ( int lengthEntered, IEnumerable list ) : void
lengthEntered int Number of characters of the current word already entered in the editor
list IEnumerable Sets the property.
return void

Show() public method

Shows the autocomplete window.
public Show ( int lengthEntered, string list ) : void
lengthEntered int Number of characters of the current word already entered in the editor
list string Sets the property.
return void

Show() public method

Shows the autocomplete window.
In this overload the lengthEntered is automatically detected by the editor.
public Show ( string list ) : void
list string Sets the property.
return void

ShowUserList() public method

Shows a UserList window
UserLists are not as powerful as autocomplete but can be assigned to a user defined index.
public ShowUserList ( int listType, IEnumerable list ) : void
listType int Index of the userlist to show. Can be any integer
list IEnumerable List of words to show.
return void

ShowUserList() public method

Shows a UserList window
UserLists are not as powerful as autocomplete but can be assigned to a user defined index.
public ShowUserList ( int listType, string list ) : void
listType int Index of the userlist to show. Can be any integer
list string List of words to show separated by " "
return void