Click or drag to resize
SingleCharWidget Class
SingleCharWidget
Inheritance Hierarchy

Namespace: MyScript.Atk.Text.Scw
Assembly: MyScript.Atk.Text.Scw (in MyScript.Atk.Text.Scw.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
C#
public sealed class SingleCharWidget : Grid, 
	ISingleCharWidgetApi, IInkViewListener, IOnTextChangedListener, IOnSingleTapGestureListener, IOnLongPressGestureListener, 
	IOnBackspaceGestureListener, IOnReturnGestureListener, IOnConfiguredListener, IOnPenDownListener, IOnPenUpListener, 
	IOnPenMoveListener, IOnPenAbortListener

The SingleCharWidget type exposes the following members.

Constructors
  NameDescription
Public methodSingleCharWidget
Initializes a new instance of the SingleCharWidget class.
Top
Properties
  NameDescription
Public propertyActualHeight
Gets the rendered height of a FrameworkElement.
(Inherited from FrameworkElement.)
Public propertyActualWidth
Gets the rendered width of a FrameworkElement.
(Inherited from FrameworkElement.)
Public propertyAllowDrop
Gets or sets a value that determines whether this UIElement can be a drop target for purposes of drag-and-drop operations.
(Inherited from UIElement.)
Public propertyAutoCommitDelay
Set the delay after which auto-commit is triggered.
Public propertyAutoCommitEnabled
Enable or disable auto-commit feature.
Public propertyAutoFreezeDelay
Set the delay after which auto-freeze is triggered.
Public propertyAutoSpaceEnabled
Enable or disable auto-space feature.
Public propertyBackground
Gets or sets a Brush that is used to fill the panel.
(Inherited from Panel.)
Public propertyBackgroundBrush
Public propertyBaseUri
Gets a Uniform Resource Identifier (URI) that represents the base Uniform Resource Identifier (URI) for an XAML-constructed object at XAML load time. This property is useful for Uniform Resource Identifier (URI) resolution at run time.
(Inherited from FrameworkElement.)
Public propertyBorderBrush (Inherited from Grid.)
Public propertyBorderThickness (Inherited from Grid.)
Public propertyCacheMode
Gets or sets a value that indicates that rendered content should be cached as a composited bitmap when possible.
(Inherited from UIElement.)
Public propertyCanDrag (Inherited from UIElement.)
Public propertyCharacterCandidateListSize
maximum number of character candidates.
Public propertyChildren
Gets the collection of child elements of the panel.
(Inherited from Panel.)
Public propertyChildrenTransitions
Gets or sets the collection of Transition style elements that apply to child content of a Panel subclass.
(Inherited from Panel.)
Public propertyClip
Gets or sets the RectangleGeometry used to define the outline of the contents of a UIElement.
(Inherited from UIElement.)
Public propertyColumnDefinitions
Gets a list of ColumnDefinition objects defined on this instance of Grid.
(Inherited from Grid.)
Public propertyCompositeMode
Gets or sets a property that declares alternate composition and blending modes for the element in its parent layout and window. This is relevant for elements that are involved in a mixed XAML / Microsoft DirectX UI.
(Inherited from UIElement.)
Public propertyCornerRadius (Inherited from Grid.)
Public propertyDataContext
Gets or sets the data context for a FrameworkElement when it participates in data binding.
(Inherited from FrameworkElement.)
Public propertyDesiredSize
Gets the size that this UIElement computed during the measure pass of the layout process.
(Inherited from UIElement.)
Public propertyDispatcher
Gets the CoreDispatcher that this object is associated with.
(Inherited from DependencyObject.)
Public propertyErrorCode
Return an error code describing the last configuration error.
Public propertyErrorString
Return a string describing the last configuration error.
Public propertyFlowDirection
Gets or sets the direction in which text and other UI elements flow within any parent element that controls their layout. This property can be set to either LeftToRight or RightToLeft. Setting FlowDirection to RightToLeft on any element sets the alignment to the right, the reading order to right-to-left and the layout of the control to flow from right to left.
(Inherited from FrameworkElement.)
Public propertyHeight
Gets or sets the suggested height of a FrameworkElement.
(Inherited from FrameworkElement.)
Public propertyHorizontalAlignment
Gets or sets the horizontal alignment characteristics that are applied to a FrameworkElement when it is composed in a layout parent, such as a panel or items control.
(Inherited from FrameworkElement.)
Public propertyInkColor
Gets or sets the color of the ink.
Public propertyInkEffect
Rendering effect applied to the ink.
Public propertyInkFadeOutDelay
Set the delay after which strokes start fading out.
Public propertyInkFadeOutDuration
Set the duration of the strokes fade-out animation.
Public propertyInkFadeOutEffect
Set the ink fade-out effect.
Public propertyInkFadeOutStep
Set the amount of alpha faded out after each pen-up event.
Public propertyInkFadeOutTo
Set the target alpha value of the strokes fade-out animation.
Public propertyInkWidth
Gets or sets the width of the ink.
Public propertyInsertIndex
Set the index of the insertion point.
Public propertyIsDoubleTapEnabled
Gets or sets a value that determines whether the DoubleTapped event can originate from that element.
(Inherited from UIElement.)
Public propertyIsHitTestVisible
Gets or sets whether the contained area of this UIElement can return true values for hit testing.
(Inherited from UIElement.)
Public propertyIsHoldingEnabled
Gets or sets a value that determines whether the Holding event can originate from that element.
(Inherited from UIElement.)
Public propertyIsItemsHost
Gets a value that indicates whether this Panel is a container for UI items that are generated by an ItemsControl.
(Inherited from Panel.)
Public propertyIsRightTapEnabled
Gets or sets a value that determines whether the RightTapped event can originate from that element.
(Inherited from UIElement.)
Public propertyIsTapEnabled
Gets or sets a value that determines whether the Tapped event can originate from that element.
(Inherited from UIElement.)
Public propertyLanguage
Gets or sets localization/globalization language information that applies to a FrameworkElement, and also to all child elements of the current FrameworkElement in the object representation and in UI.
(Inherited from FrameworkElement.)
Public propertyLongPressDelay
Set the delay after which long press event is triggered.
Public propertyManipulationMode
Gets or sets the ManipulationModes value used for UIElement behavior and interaction with gestures.
(Inherited from UIElement.)
Public propertyMargin
Gets or sets the outer margin of a FrameworkElement.
(Inherited from FrameworkElement.)
Public propertyMaxHeight
Gets or sets the maximum height constraint of a FrameworkElement.
(Inherited from FrameworkElement.)
Public propertyMaxWidth
Gets or sets the maximum width constraint of a FrameworkElement.
(Inherited from FrameworkElement.)
Public propertyMinHeight
Gets or sets the minimum height constraint of a FrameworkElement.
(Inherited from FrameworkElement.)
Public propertyMinWidth
Gets or sets the minimum width constraint of a FrameworkElement.
(Inherited from FrameworkElement.)
Public propertyName
Gets or sets the identifying name of the object. When a XAML processor creates the object tree from XAML markup, run-time code can refer to the XAML-declared object by this name.
(Inherited from FrameworkElement.)
Public propertyOpacity
Gets or sets the degree of the object's opacity.
(Inherited from UIElement.)
Public propertyPadding (Inherited from Grid.)
Public propertyParent
Gets the parent object of this FrameworkElement in the object tree.
(Inherited from FrameworkElement.)
Public propertyPointerCaptures
Gets the set of all captured pointers, represented as Pointer values.
(Inherited from UIElement.)
Public propertyProjection
Gets or sets the perspective projection (3-D effect) to apply when rendering this element.
(Inherited from UIElement.)
Public propertyRecognitionMode
Set the handwriting recognition mode.
Public propertyRenderSize
Gets the final render size of a UIElement.
(Inherited from UIElement.)
Public propertyRenderTransform
Gets or sets transform information that affects the rendering position of a UIElement.
(Inherited from UIElement.)
Public propertyRenderTransformOrigin
Gets or sets the origin point of any possible render transform declared by RenderTransform, relative to the bounds of the UIElement.
(Inherited from UIElement.)
Public propertyRequestedTheme
Gets or sets the UI theme that is used by the UIElement (and its child elements) for resource determination. The UI theme you specify with RequestedTheme can override the app-level RequestedTheme.
(Inherited from FrameworkElement.)
Public propertyResources
Gets the locally defined resource dictionary. In XAML, you can establish resource items as child object elements of a frameworkElement.Resources property element, through XAML implicit collection syntax.
(Inherited from FrameworkElement.)
Public propertyRowDefinitions
Gets a list of RowDefinition objects defined on this instance of Grid.
(Inherited from Grid.)
Public propertySpeedQualityCompromise
speed/quality compromise rating.
Public propertyStyle
Gets or sets an instance Style that is applied for this object during layout and rendering.
(Inherited from FrameworkElement.)
Public propertyTag
Gets or sets an arbitrary object value that can be used to store custom information about this object.
(Inherited from FrameworkElement.)
Public propertyText
the text managed by this widget.
Public propertyTransform3D (Inherited from UIElement.)
Public propertyTransitions
Gets or sets the collection of Transition style elements that apply to a UIElement.
(Inherited from UIElement.)
Public propertyTransliterationEnabled
Enable or disable transliteration feature.
Public propertyTriggers
Gets the collection of triggers for animations that are defined for a FrameworkElement. Not commonly used.
(Inherited from FrameworkElement.)
Public propertyUseLayoutRounding
Gets or sets a value that determines whether rendering for the object and its visual subtree should use rounding behavior that aligns rendering to whole pixels.
(Inherited from UIElement.)
Public propertyVerticalAlignment
Gets or sets the vertical alignment characteristics that are applied to a FrameworkElement when it is composed in a parent object such as a panel or items control.
(Inherited from FrameworkElement.)
Public propertyVisibility
Gets or sets the visibility of a UIElement. A UIElement that is not visible is not rendered and does not communicate its desired size to layout.
(Inherited from UIElement.)
Public propertyWidth
Gets or sets the width of a FrameworkElement.
(Inherited from FrameworkElement.)
Public propertyWordCandidateListSize
maximum number of word candidates.
Public propertyWordCompletionCandidateListSize
maximum number of word completion candidates.
Public propertyWordPredictionCandidateListSize
maximum number of word prediction candidates.
Top
Methods
  NameDescription
Public methodAddHandler
Adds a routed event handler for a specified routed event, adding the handler to the handler collection on the current element. Specify handledEventsToo as true to have the provided handler be invoked even if the event is handled elsewhere.
(Inherited from UIElement.)
Public methodAddSearchDir
Add given directory to handwriting resources search path. Directory name can point to a folder in the file system, or to a directory in a zip file. Handwriting resources can be loaded directly from the assets folder of an apk file, as shown below.
            widget.AddSearchDir("zip://" + getContext().getPackageCodePath() + "!/assets/conf/text");
            
Public methodAddStroke
Add a stroke to the widget.
Public methodArrange
Positions child objects and determines a size for a UIElement. Parent objects that implement custom layout for their child elements should call this method from their layout override implementations to form a recursive layout update.
(Inherited from UIElement.)
Public methodCancelDirectManipulations
Cancels ongoing direct manipulation processing (system-defined panning/zooming) on any ScrollViewer parent that contains the current UIElement.
(Inherited from UIElement.)
Public methodCapturePointer
Sets pointer capture to a UIElement. Once captured, only the element that has capture will fire pointer-related events.
(Inherited from UIElement.)
Public methodCharacterCandidates
Return alternate candidate info for the character at specified index. This method computes the character range of the character at specified index, and provides alternate candidates.

Alternate candidates can be selected by calling the ReplaceCharacters(Int32, Int32, String) method with parameters from the candidate information object.

Public methodClear
Clear ink and text contained in the widget.
Public methodClearSearchPath
Clear handwriting resources search path.
Public methodClearValue
Clears the local value of a dependency property.
(Inherited from DependencyObject.)
Public methodCommit
Commit the current writing session, optionally clear ink from the screen. This method commits the current writing session if not empty and starts a new one. If the current writing session is empty, the widget does not start a new one.

The meaning of a writing session depends on the current handwriting recognition mode.

  • In superimposed mode, a writing session represents any kind of text (from a single character up to several sentences) with each character written on top of the other. A commit operation freezes all strokes and text interpretation, keeps them and starts a new writing session.
  • In isolated mode, a writing session represents a single character. A commit operation indicates the end of the current character and starts the next one.
  • In cursive mode, a writing session is a single screen page, which represents from a single character up to several words and sentences, laid out on a single or multiple lines. A commit operation indicates the end of the current screen page and starts the next one.

Strokes currently displayed on the screen are either kept or removed from the screen based on the value of the

clearInk
parameter.
Public methodConfigure
Configure handwriting recognition engine. This method is non-blocking and returns immediately.

Configuration is a lengthy process that may take up to several seconds, depending on the handwriting resources to be configured. It is recommended to setup a configuration listener to detect the end of the configuration process.

When the device is rotated, Android completely recreates the UI without restarting the process of the application. After the device has been rotated, you need to configure the new instance of ISingleCharWidgetApi by calling this method again.

Public methodDisableGesture
Disable detection of the specified gesture.
Public methodEnableGesture
Enable detection of the specified gesture.
Public methodEquals (Inherited from Object.)
Public methodFindName
Retrieves an object that has the specified identifier name.
(Inherited from FrameworkElement.)
Public methodGetAnimationBaseValue
Returns any base value established for a dependency property, which would apply in cases where an animation is not active.
(Inherited from DependencyObject.)
Public methodGetBindingExpression
Returns the BindingExpression that represents the binding on the specified property.
(Inherited from FrameworkElement.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodGetUserLexicon
Return user lexicon (array of words).
Public methodGetValue
Returns the current effective value of a dependency property from a DependencyObject.
(Inherited from DependencyObject.)
Public methodInsertString
Insert the given string at the insertion point. This method inserts the given string into the input stream of the handwriting recognizer without freezing strokes. This method is particularly useful when implementing space or any other button.
Public methodInvalidateArrange
Invalidates the arrange state (layout) for a UIElement. After the invalidation, the UIElement will have its layout updated, which will occur asynchronously.
(Inherited from UIElement.)
Public methodInvalidateMeasure
Invalidates the measurement state (layout) for a UIElement.
(Inherited from UIElement.)
Public methodIsGestureEnabled
Return whether specified gesture is enabled.
Public methodMeasure
Updates the DesiredSize of a UIElement. Typically, objects that implement custom layout for their layout children call this method from their own MeasureOverride implementations to form a recursive layout update.
(Inherited from UIElement.)
Public methodPenAbort
Simulate a pen abort event.
Public methodPenDown
Simulate a pen down event. This simulates a user that starts writing.
Public methodPenMove
Simulate a pen move event. This simulates a user writing.
Public methodPenUp
Simulate a pen up event. This simulates a user that ends writing.
Public methodReadLocalValue
Returns the local value of a dependency property, if a local value is set.
(Inherited from DependencyObject.)
Public methodRegisterCertificate
Register MyScript engine certificate and return
true
on success,
false
on failure.
Public methodRegisterPropertyChangedCallback (Inherited from DependencyObject.)
Public methodReleasePointerCapture
Releases pointer captures for capture of one specific pointer by this UIElement.
(Inherited from UIElement.)
Public methodReleasePointerCaptures
Releases all pointer captures held by this element.
(Inherited from UIElement.)
Public methodRemoveHandler
Removes the specified routed event handler from this UIElement. Typically the handler in question was added by AddHandler.
(Inherited from UIElement.)
Public methodReplaceCharacters
Replace characters in the text. This method can be used to select an alternate handwriting recognition candidate for any word or character. The specified character range shall span a word or a single character, and the provided replacement text shall be one of the possible candidates to trigger a word or character candidate change.

Characters may be inserted at any location in the text by calling this method with the same start and end character indices and a non-empty replacement string.

Characters may be deleted from the text by calling this method with a non-empty characters range and an empty or

null
replacement string.
Public methodSetBinding
Attaches a binding to a FrameworkElement, using the provided binding object.
(Inherited from FrameworkElement.)
Public methodSetOnBackspaceGestureListener
Register a callback to invoke when a backspace gesture is detected.
Public methodSetOnConfiguredListener
Register a callback to invoke when configuration ends.
Public methodSetOnControllerListener
Public methodSetOnLongPressGestureListener
Register a callback to invoke when a long press gesture is detected.
Public methodSetOnPenAbortListener
Register a callback to invoke when user aborts writing.
Public methodSetOnPenDownListener
Register a callback to invoke when user starts writing.
Public methodSetOnPenMoveListener
Register a callback to invoke when user is writing.
Public methodSetOnPenUpListener
Register a callback to invoke when user ends writing.
Public methodSetOnReturnGestureListener
Register a callback to invoke when a return gesture is detected.
Public methodSetOnSingleTapGestureListener
Register a callback to invoke when a single tap gesture is detected.
Public methodSetOnTextChangedListener
Register a callback to invoke when the text changes.
Public methodSetUserLexicon
Set user lexicon (array of words).
Public methodSetValue
Sets the local value of a dependency property on a DependencyObject.
(Inherited from DependencyObject.)
Public methodStartDragAsync (Inherited from UIElement.)
Public methodToString (Inherited from Object.)
Public methodTransformToVisual
Returns a transform object that can be used to transform coordinates from the UIElement to the specified object.
(Inherited from UIElement.)
Public methodUnregisterPropertyChangedCallback (Inherited from DependencyObject.)
Public methodUpdateLayout
Ensures that all positions of child objects of a UIElement are properly updated for layout.
(Inherited from UIElement.)
Public methodWordCandidates
Return alternate candidate info for the word at specified index. This method computes the character range of the word at specified index, and provides alternate candidates and possible completions.

Alternate candidates can be selected by calling the ReplaceCharacters(Int32, Int32, String) method with parameters from the candidate information object.

Top
Events
  NameDescription
Public eventDataContextChanged
Occurs when the value of the FrameworkElement.DataContext property changes.
(Inherited from FrameworkElement.)
Public eventDoubleTapped
Occurs when an otherwise unhandled DoubleTap interaction occurs over the hit test area of this element.
(Inherited from UIElement.)
Public eventDragEnter
Occurs when the input system reports an underlying drag event with this element as the target.
(Inherited from UIElement.)
Public eventDragLeave
Occurs when the input system reports an underlying drag event with this element as the origin.
(Inherited from UIElement.)
Public eventDragOver
Occurs when the input system reports an underlying drag event with this element as the potential drop target.
(Inherited from UIElement.)
Public eventDragStarting (Inherited from UIElement.)
Public eventDrop
Occurs when the input system reports an underlying drop event with this element as the drop target.
(Inherited from UIElement.)
Public eventDropCompleted (Inherited from UIElement.)
Public eventGotFocus
Occurs when a UIElement receives focus.
(Inherited from UIElement.)
Public eventHolding
Occurs when an otherwise unhandled Hold interaction occurs over the hit test area of this element.
(Inherited from UIElement.)
Public eventKeyDown
Occurs when a keyboard key is pressed while the UIElement has focus.
(Inherited from UIElement.)
Public eventKeyUp
Occurs when a keyboard key is released while the UIElement has focus.
(Inherited from UIElement.)
Public eventLayoutUpdated
Occurs when the layout of the visual tree changes.
(Inherited from FrameworkElement.)
Public eventLoaded
Occurs when a FrameworkElement has been constructed and added to the object tree, and is ready for interaction.
(Inherited from FrameworkElement.)
Public eventLoading (Inherited from FrameworkElement.)
Public eventLostFocus
Occurs when a UIElement loses focus.
(Inherited from UIElement.)
Public eventManipulationCompleted
Occurs when a manipulation on the UIElement is complete.
(Inherited from UIElement.)
Public eventManipulationDelta
Occurs when the input device changes position during a manipulation.
(Inherited from UIElement.)
Public eventManipulationInertiaStarting
Occurs when the input device loses contact with the UIElement object during a manipulation and inertia begins.
(Inherited from UIElement.)
Public eventManipulationStarted
Occurs when an input device begins a manipulation on the UIElement.
(Inherited from UIElement.)
Public eventManipulationStarting
Occurs when the manipulation processor is first created.
(Inherited from UIElement.)
Public eventPointerCanceled
Occurs when a pointer that made contact abnormally loses contact.
(Inherited from UIElement.)
Public eventPointerCaptureLost
Occurs when pointer capture previously held by this element moves to another element or elsewhere.
(Inherited from UIElement.)
Public eventPointerEntered
Occurs when a pointer enters the hit test area of this element.
(Inherited from UIElement.)
Public eventPointerExited
Occurs when a pointer leaves the hit test area of this element.
(Inherited from UIElement.)
Public eventPointerMoved
Occurs when a pointer moves while the pointer remains within the hit test area of this element.
(Inherited from UIElement.)
Public eventPointerPressed
Occurs when the pointer device initiates a Press action within this element.
(Inherited from UIElement.)
Public eventPointerReleased
Occurs when the pointer device that previously initiated a Press action is released, while within this element.
(Inherited from UIElement.)
Public eventPointerWheelChanged
Occurs when the delta value of a pointer wheel changes.
(Inherited from UIElement.)
Public eventRightTapped
Occurs when a right-tap input stimulus happens while the pointer is over the element.
(Inherited from UIElement.)
Public eventSizeChanged
Occurs when either the ActualHeight or the ActualWidth property changes value on a FrameworkElement.
(Inherited from FrameworkElement.)
Public eventTapped
Occurs when an otherwise unhandled Tap interaction occurs over the hit test area of this element.
(Inherited from UIElement.)
Public eventUnloaded
Occurs when this object is no longer connected to the main object tree.
(Inherited from FrameworkElement.)
Top
See Also