IInkEdit interface (inked.h)
The InkEdit object enables you to collect ink, recognize ink, and display ink as text.
Inheritance
The IInkEdit interface inherits from the IUnknown interface. IInkEdit also has these types of members:
Methods
The IInkEdit interface has these methods.
| IInkEdit::get_Appearance Gets or sets a value that determines the appearance of the InkEdit control - whether it is flat (painted with no visual effects) or 3D (painted with three-dimensional effects). (Get) |
| IInkEdit::get_BackColor Gets or sets the background color for the InkEdit control. (Get) |
| IInkEdit::get_BorderStyle Gets or sets a value that determines whether the InkEdit control has a border. (Get) |
| IInkEdit::get_DisableNoScroll Gets or sets a value that determines whether scroll bars in the InkEdit control are disabled. (Get) |
| IInkEdit::get_DrawingAttributes Gets or sets the drawing attributes for ink that is yet to be drawn on the InkEdit control. (IInkEdit.get_DrawingAttributes) |
| IInkEdit::get_Enabled Gets or sets a value that determines whether the InkEdit control can respond to user-generated events. (Get) |
| IInkEdit::get_Factoid Gets or sets the Factoid constant that a IInkRecognizer object uses to constrain its search for the recognition result. (Get) |
| IInkEdit::get_Font Gets or sets a Font object. |
| IInkEdit::get_Hwnd Gets a handle to the InkEdit control. |
| IInkEdit::get_InkInsertMode Gets or sets a value that specifies how ink is inserted onto the InkEdit control, either as text or as ink. (Get) |
| IInkEdit::get_InkMode Gets or sets a value that specifies whether ink collection is disabled, ink is collected, or ink and gestures are collected. (Get) |
| IInkEdit::get_Locked Gets or sets a value indicating whether the contents of the InkEdit control can be edited. (Get) |
| IInkEdit::get_MaxLength Gets or sets a value indicating whether there is a maximum number of characters an InkEdit control can hold and, if so, specifies the maximum number of characters. (Get) |
| IInkEdit::get_MouseIcon Gets or sets the custom mouse icon for the InkEdit control. (Get) |
| IInkEdit::get_MousePointer Gets or sets a value indicating the type of mouse pointer to be displayed. (Get) |
| IInkEdit::get_MultiLine Gets or sets a value indicating whether an InkEdit control can accept and display multiple lines of text. (Get) |
| IInkEdit::get_RecognitionTimeout Gets or sets the length of time, in milliseconds, between the last IInkStrokeDisp object collected and the beginning of text recognition. (Get) |
| IInkEdit::get_Recognizer Gets or sets the IInkRecognizer object to use for recognition. |
| IInkEdit::get_ScrollBars Gets or sets the type of scroll bars, if any, to display in the InkEdit control. (Get) |
| IInkEdit::get_SelAlignment Gets or sets a value that controls the alignment of the paragraphs in an InkEdit control. (Get) |
| IInkEdit::get_SelBold Gets or sets a value that specifies whether the font style of the currently selected text in the InkEdit control is bold. (Get) |
| IInkEdit::get_SelCharOffset Returns or sets a value that determines whether text in the InkEdit control appears on the baseline (normal), as a superscript above the baseline, or as a subscript below the baseline. (Get) |
| IInkEdit::get_SelColor Gets or sets the text color of the current text selection or insertion point (run time only). (Get) |
| IInkEdit::get_SelFontName Gets or sets the font name of the selected text within the InkEdit control (run time only). (Get) |
| IInkEdit::get_SelFontSize Gets or sets the font size of the selected text within the InkEdit control (run time only). (Get) |
| IInkEdit::get_SelInks Gets or sets the array of embedded InkDisp objects (if displayed as ink) in the current selection. (Get) |
| IInkEdit::get_SelInksDisplayMode Gets or sets a value that allows for toggling the appearance of the selection between ink and text. (Get) |
| IInkEdit::get_SelItalic Gets or sets a value that specifies whether the font style of the currently selected text in the InkEdit control is italic (run time only). (Get) |
| IInkEdit::get_SelLength Gets or sets the number of characters that are selected in the InkEdit control (run time only). (Get) |
| IInkEdit::get_SelRTF Gets or sets the currently selected Rich Text Format (RTF) formatted text in the InkEdit control (run time only). (Get) |
| IInkEdit::get_SelStart Gets or sets the starting point of the text that is selected in the InkEdit control (run time only). (Get) |
| IInkEdit::get_SelText Gets or sets the selected text within the InkEdit control (run time only). (Get) |
| IInkEdit::get_SelUnderline Gets or sets a value that specifies whether the font style of the currently selected text in the InkEdit control is underlined (run time only). (Get) |
| IInkEdit::get_Status Gets a value that specifies whether the InkEdit control is idle, collecting ink, or recognizing ink. |
| IInkEdit::get_Text Gets or sets the current text in the InkEdit control. (Get) |
| IInkEdit::get_TextRTF Gets or sets the text of the InkEdit control, including all RTF codes. (Get) |
| IInkEdit::get_UseMouseForInput Gets or sets a value that indicates whether the mouse can be used as an input device. (Get) |
| IInkEdit::GetGestureStatus Indicates whether the InkEdit control is interested in a particular application gesture. |
| IInkEdit::put_Appearance Gets or sets a value that determines the appearance of the InkEdit control - whether it is flat (painted with no visual effects) or 3D (painted with three-dimensional effects). (Put) |
| IInkEdit::put_BackColor Gets or sets the background color for the InkEdit control. (Put) |
| IInkEdit::put_BorderStyle Gets or sets a value that determines whether the InkEdit control has a border. (Put) |
| IInkEdit::put_DisableNoScroll Gets or sets a value that determines whether scroll bars in the InkEdit control are disabled. (Put) |
| IInkEdit::put_Enabled Gets or sets a value that determines whether the InkEdit control can respond to user-generated events. (Put) |
| IInkEdit::put_Factoid Gets or sets the Factoid constant that a IInkRecognizer object uses to constrain its search for the recognition result. (Put) |
| IInkEdit::put_InkInsertMode Gets or sets a value that specifies how ink is inserted onto the InkEdit control, either as text or as ink. (Put) |
| IInkEdit::put_InkMode Gets or sets a value that specifies whether ink collection is disabled, ink is collected, or ink and gestures are collected. (Put) |
| IInkEdit::put_Locked Gets or sets a value indicating whether the contents of the InkEdit control can be edited. (Put) |
| IInkEdit::put_MaxLength Gets or sets a value indicating whether there is a maximum number of characters an InkEdit control can hold and, if so, specifies the maximum number of characters. (Put) |
| IInkEdit::put_MouseIcon Gets or sets the custom mouse icon for the InkEdit control. (Put) |
| IInkEdit::put_MousePointer Gets or sets a value indicating the type of mouse pointer to be displayed. (Put) |
| IInkEdit::put_MultiLine Gets or sets a value indicating whether an InkEdit control can accept and display multiple lines of text. (Put) |
| IInkEdit::put_RecognitionTimeout Gets or sets the length of time, in milliseconds, between the last IInkStrokeDisp object collected and the beginning of text recognition. (Put) |
| IInkEdit::put_ScrollBars Gets or sets the type of scroll bars, if any, to display in the InkEdit control. (Put) |
| IInkEdit::put_SelAlignment Gets or sets a value that controls the alignment of the paragraphs in an InkEdit control. (Put) |
| IInkEdit::put_SelBold Gets or sets a value that specifies whether the font style of the currently selected text in the InkEdit control is bold. (Put) |
| IInkEdit::put_SelCharOffset Returns or sets a value that determines whether text in the InkEdit control appears on the baseline (normal), as a superscript above the baseline, or as a subscript below the baseline. (Put) |
| IInkEdit::put_SelColor Gets or sets the text color of the current text selection or insertion point (run time only). (Put) |
| IInkEdit::put_SelFontName Gets or sets the font name of the selected text within the InkEdit control (run time only). (Put) |
| IInkEdit::put_SelFontSize Gets or sets the font size of the selected text within the InkEdit control (run time only). (Put) |
| IInkEdit::put_SelInks Gets or sets the array of embedded InkDisp objects (if displayed as ink) in the current selection. (Put) |
| IInkEdit::put_SelInksDisplayMode Gets or sets a value that allows for toggling the appearance of the selection between ink and text. (Put) |
| IInkEdit::put_SelItalic Gets or sets a value that specifies whether the font style of the currently selected text in the InkEdit control is italic (run time only). (Put) |
| IInkEdit::put_SelLength Gets or sets the number of characters that are selected in the InkEdit control (run time only). (Put) |
| IInkEdit::put_SelRTF Gets or sets the currently selected Rich Text Format (RTF) formatted text in the InkEdit control (run time only). (Put) |
| IInkEdit::put_SelStart Gets or sets the starting point of the text that is selected in the InkEdit control (run time only). (Put) |
| IInkEdit::put_SelText Gets or sets the selected text within the InkEdit control (run time only). (Put) |
| IInkEdit::put_SelUnderline Gets or sets a value that specifies whether the font style of the currently selected text in the InkEdit control is underlined (run time only). (Put) |
| IInkEdit::put_Text Gets or sets the current text in the InkEdit control. (Put) |
| IInkEdit::put_TextRTF Gets or sets the text of the InkEdit control, including all RTF codes. (Put) |
| IInkEdit::put_UseMouseForInput Gets or sets a value that indicates whether the mouse can be used as an input device. (Put) |
| IInkEdit::putref_DrawingAttributes Gets or sets the drawing attributes for ink that is yet to be drawn on the InkEdit control. |
| IInkEdit::putref_Font Gets or sets the font for text that is yet to be drawn on the InkEdit control. |
| IInkEdit::putref_MouseIcon Gets or sets the mouse icon displayed on the InkEdit control. |
| IInkEdit::putref_Recognizer Gets or sets the recognizer used with the InkEdit control. |
| IInkEdit::Recognize Performs recognition on an InkStrokes collection and returns recognition results. (IInkEdit.Recognize) |
| IInkEdit::Refresh Causes the InkEdit control to redraw. |
| IInkEdit::SetGestureStatus Modifies the interest of the InkEdit control in a known application gesture. |
Requirements
| Requirement | Value |
|---|---|
| Target Platform | Windows |
| Header | inked.h |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for