C# Класс Scroller.ScrollerPlugin

Наследование: IPlugin, IHighlighterService

Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство	Тип	Описание
PluginId	INamedVersionedUniqueId

Private Properties

Свойство	Тип	Описание
BrowseTree	bool
OnConfigChanged	void
OnInputTriggered	void

Открытые методы

Метод	Описание
HighlightImmediately ( IHighlightableElement element ) : void	This function forces the highlight of the given element. This function is useful only when there is no alternative to.
Pause ( bool forceEndHighlight = false ) : void
RegisterInRegisteredElementAt ( string targetModuleName, string extensibleElementName, ChildPosition position, IHighlightableElement element ) : bool	Enables registering a tree node (and its children) in an already registered module. The module has to have an IExtensibleHighlightableElement whose name matches the extensibleElementName set as parameter.
RegisterTree ( string targetModuleName, string targetDisplayName, IHighlightableElement element, bool HighlightDirectly = false ) : void
Resume ( ) : void
Setup ( CK.Plugin.IPluginSetupInfo info ) : bool
Start ( ) : void
Stop ( ) : void
Teardown ( ) : void
UnregisterInRegisteredElement ( string targetModuleName, string extensibleElementName, ChildPosition position, IHighlightableElement element ) : bool	Enables unregistering a tree node (and its children) that had been registered inside an already registered module (see RegisterInRegisteredElementAt )
UnregisterTree ( string targetModuleName, IHighlightableElement element ) : void

Приватные методы

Метод	Описание
BrowseTree ( IHighlightableElement element, bool>.Func doing ) : bool	This method calls the function with with "element" as parameter and then calls it on each of its hightlightable children. At any point, if the function returns false, the browsing stops.
OnConfigChanged ( object sender, CK.Plugin.Config.ConfigChangedEventArgs e ) : void
OnInputTriggered ( ITrigger t ) : void

Описание методов

HighlightImmediately() публичный Метод

This function forces the highlight of the given element.

This function is useful only when there is no alternative to.

public HighlightImmediately ( IHighlightableElement element ) : void
element	IHighlightableElement	The element highlight.
Результат	void

Pause() публичный Метод

public Pause ( bool forceEndHighlight = false ) : void
forceEndHighlight	bool
Результат	void

RegisterInRegisteredElementAt() публичный Метод

Enables registering a tree node (and its children) in an already registered module. The module has to have an IExtensibleHighlightableElement whose name matches the extensibleElementName set as parameter.

public RegisterInRegisteredElementAt ( string targetModuleName, string extensibleElementName, ChildPosition position, IHighlightableElement element ) : bool
targetModuleName	string	The name of the target module
extensibleElementName	string	The name of the target node
position	ChildPosition
element	IHighlightableElement	The element to register
Результат	bool

RegisterTree() публичный Метод

public RegisterTree ( string targetModuleName, string targetDisplayName, IHighlightableElement element, bool HighlightDirectly = false ) : void
targetModuleName	string
targetDisplayName	string
element	IHighlightableElement
HighlightDirectly	bool
Результат	void

Resume() публичный Метод

public Resume ( ) : void
Результат	void

Setup() публичный Метод

public Setup ( CK.Plugin.IPluginSetupInfo info ) : bool
info	CK.Plugin.IPluginSetupInfo
Результат	bool

Start() публичный Метод

public Start ( ) : void
Результат	void

Stop() публичный Метод

public Stop ( ) : void
Результат	void

Teardown() публичный Метод

public Teardown ( ) : void
Результат	void

UnregisterInRegisteredElement() публичный Метод

Enables unregistering a tree node (and its children) that had been registered inside an already registered module (see RegisterInRegisteredElementAt )

public UnregisterInRegisteredElement ( string targetModuleName, string extensibleElementName, ChildPosition position, IHighlightableElement element ) : bool
targetModuleName	string	The name of the target module
extensibleElementName	string	The name of the target node
position	ChildPosition
element	IHighlightableElement	The element to unregister
Результат	bool

UnregisterTree() публичный Метод

public UnregisterTree ( string targetModuleName, IHighlightableElement element ) : void
targetModuleName	string
element	IHighlightableElement
Результат	void

Описание свойств

PluginId публичное статическое свойство

public static INamedVersionedUniqueId PluginId
Результат	INamedVersionedUniqueId