C# Class Microsoft.Windows.Controls.KeyTipService

The service class which enables and manages KeyTips.
ファイルを表示 Open project: kasicass/kasicass

Public Properties

Property Type Description
ActivatingKeyTipEvent System.Windows.RoutedEvent
IsKeyTipScopeProperty DependencyProperty
KeyTipAccessedEvent RoutedEvent
KeyTipProperty DependencyProperty
KeyTipStyleProperty DependencyProperty
PreviewKeyTipAccessedEvent RoutedEvent

Private Properties

Property Type Description
AddElementForKeyTipScoping void
AddElementToScope void
AddItemToArrayListRef void
AddKeyTipFocusEventHandler void
AutoGenerateKeyTips void
CanUnregisterKeyTipElement bool
EnqueueAdornerLayerForPlacementProcessing void
EnterKeyTipMode bool
FindKeyTipMatches List
FindScope DependencyObject
FindScope DependencyObject
GetAdornerLayer AdornerLayer
GetCanClipKeyTip bool
GetCultureForElement CultureInfo
GetCustomSiblingKeyTipElements IEnumerable
GetGlobalScopeForElement DependencyObject
GetKeyTipAutoGenerationElements IEnumerable
GetNextAutoGenerationKeyTip string
HideCurrentShowingKeyTips void
HideKeyTipForElement void
HookKeyTipElementEventHandlers void
IsAutoGeneratedKeyTip bool
IsKeyTipClosingKey bool
IsKeyTipKey bool
KeyTipService System
LeaveKeyTipMode void
LeaveKeyTipMode void
LinkKeyTipControlToAdorner void
OnCustomSiblingKeyTipElementsChanged void
OnEscapeKeyDown void
OnIsKeyTipScopeChanged void
OnKeyTipAutoGenerationElementsChanged void
OnKeyTipChanged void
OnKeyTipElementLoaded void
OnKeyTipElementUnLoaded void
OnKeyTipExactMatch void
OnKeyTipKeyDown void
OnKeyTipPartialMatch void
OnKeyTipScopeChanged void
OnPreviewKeyDown void
OnPreviewKeyTipKeyUp void
OnPreviewTextInput void
OnShowingKeyTipChanged void
OnWindowDeactivated void
OnWindowLocationChanged void
OnWindowSizeChanged void
PopKeyTipScope void
PostProcessInput void
PreProcessInput void
ProcessKeyTipScopeChange void
ProcessScoping void
RaiseKeyTipFocusEvent void
ReevaluateScopes void
RegisterKeyTipElement void
RemoveKeyTipFocusEventHandler void
Reset void
ResetAutoGeneratedKeyTips void
SetCanClipKeyTip void
SetCustomSiblingKeyTipElements void
SetKeyTipAutoGenerationElements void
ShowKeyTipForElement bool
ShowKeyTips void
ShowKeyTipsForScope bool
ShowKeyTipsForScope bool
StartShowKeyTipsTimer void
UnhookKeyTipElementEventHandlers void
UnlinkKeyTipControlFromAdorner void
UnregisterKeyTipElement void

Public Methods

Method Description
AddActivatingKeyTipHandler ( DependencyObject element, ActivatingKeyTipEventHandler handler ) : void
AddKeyTipAccessedHandler ( DependencyObject element, KeyTipAccessedEventHandler handler ) : void
AddPreviewKeyTipAccessedHandler ( DependencyObject element, KeyTipAccessedEventHandler handler ) : void
DismissKeyTips ( ) : void
GetIsKeyTipScope ( DependencyObject element ) : bool
GetKeyTip ( DependencyObject element ) : string

Gets the value of KeyTip on the specified object
GetKeyTipStyle ( DependencyObject element ) : Style
RemoveActivatingKeyTipHandler ( DependencyObject element, ActivatingKeyTipEventHandler handler ) : void
RemoveKeyTipAccessedHandler ( DependencyObject element, KeyTipAccessedEventHandler handler ) : void
RemovePreviewKeyTipAccessedHandler ( DependencyObject element, KeyTipAccessedEventHandler handler ) : void
SetIsKeyTipScope ( DependencyObject element, bool value ) : void
SetKeyTip ( DependencyObject element, string value ) : void

Sets the value of KeyTip on the specified object
SetKeyTipStyle ( DependencyObject element, Style value ) : void

Private Methods

Method Description
AddElementForKeyTipScoping ( DependencyObject element ) : void
AddElementToScope ( DependencyObject scopedParent, DependencyObject element ) : void
AddItemToArrayListRef ( object item, ArrayList &list ) : void
AddKeyTipFocusEventHandler ( KeyTipFocusEventHandler handler, List &handlerList ) : void

Helper method to add weakhandler to the list
AutoGenerateKeyTips ( WeakHashSet currentScopeElements ) : void

Method which generates keytips for elements provided by KeyTipAutoGenerationElements enumerables in current scope.
CanUnregisterKeyTipElement ( DependencyObject element ) : bool
EnqueueAdornerLayerForPlacementProcessing ( AdornerLayer adornerLayer ) : void
EnterKeyTipMode ( DependencyObject scope, bool showKeyTips, bool showAsync ) : bool
FindKeyTipMatches ( string text, DependencyObject &exactMatchElement ) : List
FindScope ( DependencyObject element ) : DependencyObject
FindScope ( DependencyObject element, bool searchVisualTreeOnly ) : DependencyObject
GetAdornerLayer ( Visual visual, bool &isScrollAdornerLayer ) : AdornerLayer

Returns the adorner layer to be used for keytips. The implementation is similar to that of AdornerLayer's except we ignore AdornerLayer of ScrollContentPresenter if its ScrollViewer has CanClipKeyTip set to false.
GetCanClipKeyTip ( DependencyObject element ) : bool
GetCultureForElement ( DependencyObject element ) : CultureInfo
GetCustomSiblingKeyTipElements ( DependencyObject element ) : IEnumerable
GetGlobalScopeForElement ( DependencyObject element ) : DependencyObject
GetKeyTipAutoGenerationElements ( DependencyObject obj ) : IEnumerable
GetNextAutoGenerationKeyTip ( DependencyObject targetAutoGenerationScope ) : string

Helper method to return next keytip string in the auto generation sequence.
HideCurrentShowingKeyTips ( ) : void
HideKeyTipForElement ( DependencyObject element ) : void
HookKeyTipElementEventHandlers ( DependencyObject element ) : void
IsAutoGeneratedKeyTip ( string keyTip ) : bool

Helper method which determines if the keytip was auto generated or not.
IsKeyTipClosingKey ( KeyEventArgs e ) : bool
IsKeyTipKey ( KeyEventArgs e ) : bool
KeyTipService ( ) : System
LeaveKeyTipMode ( ) : void
LeaveKeyTipMode ( bool restoreFocus ) : void
LinkKeyTipControlToAdorner ( KeyTipAdorner adorner, DependencyObject keyTipElement ) : void
OnCustomSiblingKeyTipElementsChanged ( DependencyObject d, DependencyPropertyChangedEventArgs e ) : void
OnEscapeKeyDown ( KeyEventArgs keyArgs ) : void
OnIsKeyTipScopeChanged ( DependencyObject d, DependencyPropertyChangedEventArgs e ) : void
OnKeyTipAutoGenerationElementsChanged ( DependencyObject d, DependencyPropertyChangedEventArgs e ) : void
OnKeyTipChanged ( DependencyObject d, DependencyPropertyChangedEventArgs e ) : void
OnKeyTipElementLoaded ( object sender, RoutedEventArgs e ) : void
OnKeyTipElementUnLoaded ( object sender, RoutedEventArgs e ) : void
OnKeyTipExactMatch ( DependencyObject exactMatchElement ) : void
OnKeyTipKeyDown ( KeyEventArgs keyArgs ) : void
OnKeyTipPartialMatch ( List activeKeyTipElements, string text ) : void
OnKeyTipScopeChanged ( DependencyObject d, DependencyPropertyChangedEventArgs e ) : void
OnPreviewKeyDown ( KeyEventArgs keyArgs ) : void
OnPreviewKeyTipKeyUp ( KeyEventArgs keyArgs ) : void
OnPreviewTextInput ( TextCompositionEventArgs textArgs ) : void
OnShowingKeyTipChanged ( DependencyObject element, DependencyPropertyChangedEventArgs e ) : void
OnWindowDeactivated ( object sender, EventArgs e ) : void
OnWindowLocationChanged ( object sender, EventArgs e ) : void
OnWindowSizeChanged ( object sender, SizeChangedEventArgs e ) : void
PopKeyTipScope ( ) : void
PostProcessInput ( object sender, ProcessInputEventArgs e ) : void
PreProcessInput ( object sender, PreProcessInputEventArgs e ) : void
ProcessKeyTipScopeChange ( DependencyObject scopeElement, bool newIsScope ) : void
ProcessScoping ( ) : void
RaiseKeyTipFocusEvent ( object sender, EventArgs e, List handlerList ) : void

Helper method to iterate through list of weak event handlers and call them until the event is handled.
ReevaluateScopes ( DependencyObject scopedParent, bool>.Dictionary processedElements ) : void

Reevalutates the scoping for all elements under the given scope.
RegisterKeyTipElement ( DependencyObject element ) : void
RemoveKeyTipFocusEventHandler ( KeyTipFocusEventHandler handler, List handlerList ) : void

Helper method to remove weakhandler from the list.
Reset ( ) : void
ResetAutoGeneratedKeyTips ( ) : void
SetCanClipKeyTip ( DependencyObject element, bool value ) : void
SetCustomSiblingKeyTipElements ( DependencyObject element, IEnumerable value ) : void
SetKeyTipAutoGenerationElements ( DependencyObject obj, IEnumerable value ) : void
ShowKeyTipForElement ( DependencyObject element ) : bool
ShowKeyTips ( ) : void
ShowKeyTipsForScope ( DependencyObject scopeElement ) : bool
ShowKeyTipsForScope ( DependencyObject scopeElement, bool pushOnEmpty ) : bool
StartShowKeyTipsTimer ( ) : void
UnhookKeyTipElementEventHandlers ( DependencyObject element ) : void
UnlinkKeyTipControlFromAdorner ( KeyTipAdorner adorner ) : void
UnregisterKeyTipElement ( DependencyObject element ) : void

Method Details

AddActivatingKeyTipHandler() public static method

public static AddActivatingKeyTipHandler ( DependencyObject element, ActivatingKeyTipEventHandler handler ) : void
element System.Windows.DependencyObject
handler ActivatingKeyTipEventHandler
return void

AddKeyTipAccessedHandler() public static method

public static AddKeyTipAccessedHandler ( DependencyObject element, KeyTipAccessedEventHandler handler ) : void
element System.Windows.DependencyObject
handler KeyTipAccessedEventHandler
return void

AddPreviewKeyTipAccessedHandler() public static method

public static AddPreviewKeyTipAccessedHandler ( DependencyObject element, KeyTipAccessedEventHandler handler ) : void
element System.Windows.DependencyObject
handler KeyTipAccessedEventHandler
return void

DismissKeyTips() public static method

public static DismissKeyTips ( ) : void
return void

GetIsKeyTipScope() public static method

public static GetIsKeyTipScope ( DependencyObject element ) : bool
element DependencyObject
return bool

GetKeyTip() public static method

Gets the value of KeyTip on the specified object
public static GetKeyTip ( DependencyObject element ) : string
element DependencyObject
return string

GetKeyTipStyle() public static method

public static GetKeyTipStyle ( DependencyObject element ) : Style
element DependencyObject
return Style

RemoveActivatingKeyTipHandler() public static method

public static RemoveActivatingKeyTipHandler ( DependencyObject element, ActivatingKeyTipEventHandler handler ) : void
element DependencyObject
handler ActivatingKeyTipEventHandler
return void

RemoveKeyTipAccessedHandler() public static method

public static RemoveKeyTipAccessedHandler ( DependencyObject element, KeyTipAccessedEventHandler handler ) : void
element DependencyObject
handler KeyTipAccessedEventHandler
return void

RemovePreviewKeyTipAccessedHandler() public static method

public static RemovePreviewKeyTipAccessedHandler ( DependencyObject element, KeyTipAccessedEventHandler handler ) : void
element DependencyObject
handler KeyTipAccessedEventHandler
return void

SetIsKeyTipScope() public static method

public static SetIsKeyTipScope ( DependencyObject element, bool value ) : void
element DependencyObject
value bool
return void

SetKeyTip() public static method

Sets the value of KeyTip on the specified object
public static SetKeyTip ( DependencyObject element, string value ) : void
element DependencyObject
value string
return void

SetKeyTipStyle() public static method

public static SetKeyTipStyle ( DependencyObject element, Style value ) : void
element DependencyObject
value Style
return void

Property Details

ActivatingKeyTipEvent public_oe static_oe property

public static RoutedEvent,System.Windows ActivatingKeyTipEvent
return System.Windows.RoutedEvent

IsKeyTipScopeProperty public_oe static_oe property

public static DependencyProperty IsKeyTipScopeProperty
return DependencyProperty

KeyTipAccessedEvent public_oe static_oe property

public static RoutedEvent KeyTipAccessedEvent
return RoutedEvent

KeyTipProperty public_oe static_oe property

DependencyProperty for KeyTip string.
public static DependencyProperty KeyTipProperty
return DependencyProperty

KeyTipStyleProperty public_oe static_oe property

public static DependencyProperty KeyTipStyleProperty
return DependencyProperty

PreviewKeyTipAccessedEvent public_oe static_oe property

public static RoutedEvent PreviewKeyTipAccessedEvent
return RoutedEvent