INSTextInputClient Interface

Definition

Namespace:: AppKit

Assembly:: Microsoft.macOS.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

This interface represents the Objective-C protocol NSTextInputClient.

[Foundation.Protocol(Name="NSTextInputClient", WrapperType=typeof(AppKit.NSTextInputClientWrapper))]
[Foundation.ProtocolMember(IsProperty=false, IsRequired=true, IsStatic=false, Name="InsertText", ParameterByRef=new System.Boolean[] { false, false }, ParameterType=new System.Type[] { typeof(Foundation.NSObject), typeof(Foundation.NSRange) }, Selector="insertText:replacementRange:")]
[Foundation.ProtocolMember(IsProperty=false, IsRequired=true, IsStatic=false, Name="SetMarkedText", ParameterByRef=new System.Boolean[] { false, false, false }, ParameterType=new System.Type[] { typeof(Foundation.NSObject), typeof(Foundation.NSRange), typeof(Foundation.NSRange) }, Selector="setMarkedText:selectedRange:replacementRange:")]
[Foundation.ProtocolMember(IsProperty=false, IsRequired=true, IsStatic=false, Name="UnmarkText", Selector="unmarkText")]
[Foundation.ProtocolMember(IsProperty=false, IsRequired=true, IsStatic=false, Name="GetAttributedSubstring", ParameterByRef=new System.Boolean[] { false, true }, ParameterType=new System.Type[] { typeof(Foundation.NSRange), typeof(Foundation.NSRange) }, ReturnType=typeof(Foundation.NSAttributedString), Selector="attributedSubstringForProposedRange:actualRange:")]
[Foundation.ProtocolMember(IsProperty=false, IsRequired=true, IsStatic=false, Name="GetFirstRect", ParameterByRef=new System.Boolean[] { false, true }, ParameterType=new System.Type[] { typeof(Foundation.NSRange), typeof(Foundation.NSRange) }, ReturnType=typeof(CoreGraphics.CGRect), Selector="firstRectForCharacterRange:actualRange:")]
[Foundation.ProtocolMember(IsProperty=false, IsRequired=true, IsStatic=false, Name="GetCharacterIndex", ParameterByRef=new System.Boolean[] { false }, ParameterType=new System.Type[] { typeof(CoreGraphics.CGPoint) }, ReturnType=typeof(System.UIntPtr), Selector="characterIndexForPoint:")]
[Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="GetFractionOfDistanceThroughGlyph", ParameterByRef=new System.Boolean[] { false }, ParameterType=new System.Type[] { typeof(CoreGraphics.CGPoint) }, ReturnType=typeof(System.Runtime.InteropServices.NFloat), Selector="fractionOfDistanceThroughGlyphForPoint:")]
[Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="GetBaselineDelta", ParameterByRef=new System.Boolean[] { false }, ParameterType=new System.Type[] { typeof(System.UIntPtr) }, ReturnType=typeof(System.Runtime.InteropServices.NFloat), Selector="baselineDeltaForCharacterAtIndex:")]
[Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="DrawsVertically", ParameterByRef=new System.Boolean[] { false }, ParameterType=new System.Type[] { typeof(System.UIntPtr) }, ReturnType=typeof(System.Boolean), Selector="drawsVerticallyForCharacterAtIndex:")]
[Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="InsertAdaptiveImageGlyph", ParameterByRef=new System.Boolean[] { false, false }, ParameterType=new System.Type[] { typeof(AppKit.NSAdaptiveImageGlyph), typeof(Foundation.NSRange) }, Selector="insertAdaptiveImageGlyph:replacementRange:")]
[Foundation.ProtocolMember(ArgumentSemantic=ObjCRuntime.ArgumentSemantic.None, GetterSelector="selectedRange", IsProperty=true, IsRequired=true, IsStatic=false, Name="SelectedRange", PropertyType=typeof(Foundation.NSRange), Selector="selectedRange")]
[Foundation.ProtocolMember(ArgumentSemantic=ObjCRuntime.ArgumentSemantic.None, GetterSelector="markedRange", IsProperty=true, IsRequired=true, IsStatic=false, Name="MarkedRange", PropertyType=typeof(Foundation.NSRange), Selector="markedRange")]
[Foundation.ProtocolMember(ArgumentSemantic=ObjCRuntime.ArgumentSemantic.None, GetterSelector="hasMarkedText", IsProperty=true, IsRequired=true, IsStatic=false, Name="HasMarkedText", PropertyType=typeof(System.Boolean), Selector="hasMarkedText")]
[Foundation.ProtocolMember(ArgumentSemantic=ObjCRuntime.ArgumentSemantic.None, GetterSelector="validAttributesForMarkedText", IsProperty=true, IsRequired=true, IsStatic=false, Name="ValidAttributesForMarkedText", PropertyType=typeof(Foundation.NSString[]), Selector="validAttributesForMarkedText")]
[Foundation.ProtocolMember(ArgumentSemantic=ObjCRuntime.ArgumentSemantic.None, GetterSelector="attributedString", IsProperty=true, IsRequired=false, IsStatic=false, Name="AttributedString", PropertyType=typeof(Foundation.NSAttributedString), Selector="attributedString")]
[Foundation.ProtocolMember(ArgumentSemantic=ObjCRuntime.ArgumentSemantic.None, GetterSelector="windowLevel", IsProperty=true, IsRequired=false, IsStatic=false, Name="WindowLevel", PropertyType=typeof(AppKit.NSWindowLevel), Selector="windowLevel")]
[Foundation.ProtocolMember(ArgumentSemantic=ObjCRuntime.ArgumentSemantic.None, GetterSelector="unionRectInVisibleSelectedRange", IsProperty=true, IsRequired=false, IsStatic=false, Name="UnionRectInVisibleSelectedRange", PropertyType=typeof(CoreGraphics.CGRect), Selector="unionRectInVisibleSelectedRange")]
[Foundation.ProtocolMember(ArgumentSemantic=ObjCRuntime.ArgumentSemantic.None, GetterSelector="documentVisibleRect", IsProperty=true, IsRequired=false, IsStatic=false, Name="DocumentVisibleRect", PropertyType=typeof(CoreGraphics.CGRect), Selector="documentVisibleRect")]
[Foundation.ProtocolMember(ArgumentSemantic=ObjCRuntime.ArgumentSemantic.None, GetterSelector="preferredTextAccessoryPlacement", IsProperty=true, IsRequired=false, IsStatic=false, Name="PreferredTextAccessoryPlacement", PropertyType=typeof(AppKit.NSTextCursorAccessoryPlacement), Selector="preferredTextAccessoryPlacement")]
[Foundation.ProtocolMember(ArgumentSemantic=ObjCRuntime.ArgumentSemantic.None, GetterSelector="supportsAdaptiveImageGlyph", IsProperty=true, IsRequired=false, IsStatic=false, Name="SupportsAdaptiveImageGlyph", PropertyType=typeof(System.Boolean), Selector="supportsAdaptiveImageGlyph")]
public interface INSTextInputClient : IDisposable, ObjCRuntime.INativeObject

[<Foundation.Protocol(Name="NSTextInputClient", WrapperType=typeof(AppKit.NSTextInputClientWrapper))>]
[<Foundation.ProtocolMember(IsProperty=false, IsRequired=true, IsStatic=false, Name="InsertText", ParameterByRef=new System.Boolean[] { false, false }, ParameterType=new System.Type[] { typeof(Foundation.NSObject), typeof(Foundation.NSRange) }, Selector="insertText:replacementRange:")>]
[<Foundation.ProtocolMember(IsProperty=false, IsRequired=true, IsStatic=false, Name="SetMarkedText", ParameterByRef=new System.Boolean[] { false, false, false }, ParameterType=new System.Type[] { typeof(Foundation.NSObject), typeof(Foundation.NSRange), typeof(Foundation.NSRange) }, Selector="setMarkedText:selectedRange:replacementRange:")>]
[<Foundation.ProtocolMember(IsProperty=false, IsRequired=true, IsStatic=false, Name="UnmarkText", Selector="unmarkText")>]
[<Foundation.ProtocolMember(IsProperty=false, IsRequired=true, IsStatic=false, Name="GetAttributedSubstring", ParameterByRef=new System.Boolean[] { false, true }, ParameterType=new System.Type[] { typeof(Foundation.NSRange), typeof(Foundation.NSRange) }, ReturnType=typeof(Foundation.NSAttributedString), Selector="attributedSubstringForProposedRange:actualRange:")>]
[<Foundation.ProtocolMember(IsProperty=false, IsRequired=true, IsStatic=false, Name="GetFirstRect", ParameterByRef=new System.Boolean[] { false, true }, ParameterType=new System.Type[] { typeof(Foundation.NSRange), typeof(Foundation.NSRange) }, ReturnType=typeof(CoreGraphics.CGRect), Selector="firstRectForCharacterRange:actualRange:")>]
[<Foundation.ProtocolMember(IsProperty=false, IsRequired=true, IsStatic=false, Name="GetCharacterIndex", ParameterByRef=new System.Boolean[] { false }, ParameterType=new System.Type[] { typeof(CoreGraphics.CGPoint) }, ReturnType=typeof(System.UIntPtr), Selector="characterIndexForPoint:")>]
[<Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="GetFractionOfDistanceThroughGlyph", ParameterByRef=new System.Boolean[] { false }, ParameterType=new System.Type[] { typeof(CoreGraphics.CGPoint) }, ReturnType=typeof(System.Runtime.InteropServices.NFloat), Selector="fractionOfDistanceThroughGlyphForPoint:")>]
[<Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="GetBaselineDelta", ParameterByRef=new System.Boolean[] { false }, ParameterType=new System.Type[] { typeof(System.UIntPtr) }, ReturnType=typeof(System.Runtime.InteropServices.NFloat), Selector="baselineDeltaForCharacterAtIndex:")>]
[<Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="DrawsVertically", ParameterByRef=new System.Boolean[] { false }, ParameterType=new System.Type[] { typeof(System.UIntPtr) }, ReturnType=typeof(System.Boolean), Selector="drawsVerticallyForCharacterAtIndex:")>]
[<Foundation.ProtocolMember(IsProperty=false, IsRequired=false, IsStatic=false, Name="InsertAdaptiveImageGlyph", ParameterByRef=new System.Boolean[] { false, false }, ParameterType=new System.Type[] { typeof(AppKit.NSAdaptiveImageGlyph), typeof(Foundation.NSRange) }, Selector="insertAdaptiveImageGlyph:replacementRange:")>]
[<Foundation.ProtocolMember(ArgumentSemantic=ObjCRuntime.ArgumentSemantic.None, GetterSelector="selectedRange", IsProperty=true, IsRequired=true, IsStatic=false, Name="SelectedRange", PropertyType=typeof(Foundation.NSRange), Selector="selectedRange")>]
[<Foundation.ProtocolMember(ArgumentSemantic=ObjCRuntime.ArgumentSemantic.None, GetterSelector="markedRange", IsProperty=true, IsRequired=true, IsStatic=false, Name="MarkedRange", PropertyType=typeof(Foundation.NSRange), Selector="markedRange")>]
[<Foundation.ProtocolMember(ArgumentSemantic=ObjCRuntime.ArgumentSemantic.None, GetterSelector="hasMarkedText", IsProperty=true, IsRequired=true, IsStatic=false, Name="HasMarkedText", PropertyType=typeof(System.Boolean), Selector="hasMarkedText")>]
[<Foundation.ProtocolMember(ArgumentSemantic=ObjCRuntime.ArgumentSemantic.None, GetterSelector="validAttributesForMarkedText", IsProperty=true, IsRequired=true, IsStatic=false, Name="ValidAttributesForMarkedText", PropertyType=typeof(Foundation.NSString[]), Selector="validAttributesForMarkedText")>]
[<Foundation.ProtocolMember(ArgumentSemantic=ObjCRuntime.ArgumentSemantic.None, GetterSelector="attributedString", IsProperty=true, IsRequired=false, IsStatic=false, Name="AttributedString", PropertyType=typeof(Foundation.NSAttributedString), Selector="attributedString")>]
[<Foundation.ProtocolMember(ArgumentSemantic=ObjCRuntime.ArgumentSemantic.None, GetterSelector="windowLevel", IsProperty=true, IsRequired=false, IsStatic=false, Name="WindowLevel", PropertyType=typeof(AppKit.NSWindowLevel), Selector="windowLevel")>]
[<Foundation.ProtocolMember(ArgumentSemantic=ObjCRuntime.ArgumentSemantic.None, GetterSelector="unionRectInVisibleSelectedRange", IsProperty=true, IsRequired=false, IsStatic=false, Name="UnionRectInVisibleSelectedRange", PropertyType=typeof(CoreGraphics.CGRect), Selector="unionRectInVisibleSelectedRange")>]
[<Foundation.ProtocolMember(ArgumentSemantic=ObjCRuntime.ArgumentSemantic.None, GetterSelector="documentVisibleRect", IsProperty=true, IsRequired=false, IsStatic=false, Name="DocumentVisibleRect", PropertyType=typeof(CoreGraphics.CGRect), Selector="documentVisibleRect")>]
[<Foundation.ProtocolMember(ArgumentSemantic=ObjCRuntime.ArgumentSemantic.None, GetterSelector="preferredTextAccessoryPlacement", IsProperty=true, IsRequired=false, IsStatic=false, Name="PreferredTextAccessoryPlacement", PropertyType=typeof(AppKit.NSTextCursorAccessoryPlacement), Selector="preferredTextAccessoryPlacement")>]
[<Foundation.ProtocolMember(ArgumentSemantic=ObjCRuntime.ArgumentSemantic.None, GetterSelector="supportsAdaptiveImageGlyph", IsProperty=true, IsRequired=false, IsStatic=false, Name="SupportsAdaptiveImageGlyph", PropertyType=typeof(System.Boolean), Selector="supportsAdaptiveImageGlyph")>]
type INSTextInputClient = interface
    interface INativeObject
    interface IDisposable

Derived: AppKit.INSTextCheckingClient

AppKit.NSTextInputClient

AppKit.NSTextView

Attributes: ProtocolAttribute ProtocolMemberAttribute

Implements: INativeObject IDisposable

Remarks

A class that implements this interface (and subclasses NSObject) will be exported to Objective-C as implementing the Objective-C protocol this interface represents.

A class may also implement members from this interface to implement members from the protocol.

Properties

Name	Description
AttributedString
DocumentVisibleRect
Handle	Handle (pointer) to the unmanaged object representation. (Inherited from INativeObject)
HasMarkedText
MarkedRange
PreferredTextAccessoryPlacement
SelectedRange
SupportsAdaptiveImageGlyph
UnionRectInVisibleSelectedRange
ValidAttributesForMarkedText
WindowLevel

Methods

Name	Description
DrawsVertically(UIntPtr)
GetAttributedSubstring(NSRange, NSRange)
GetBaselineDelta(UIntPtr)
GetCharacterIndex(CGPoint)
GetFirstRect(NSRange, NSRange)
GetFractionOfDistanceThroughGlyph(CGPoint)
InsertAdaptiveImageGlyph(NSAdaptiveImageGlyph, NSRange)
InsertText(NSObject, NSRange)
SetMarkedText(NSObject, NSRange, NSRange)
UnmarkText()

Extension Methods

Name	Description
DrawsVertically(INSTextInputClient, UIntPtr)
GetAttributedString(INSTextInputClient)
GetBaselineDelta(INSTextInputClient, UIntPtr)
GetDocumentVisibleRect(INSTextInputClient)
GetFractionOfDistanceThroughGlyph(INSTextInputClient, CGPoint)
GetPreferredTextAccessoryPlacement(INSTextInputClient)
GetSupportsAdaptiveImageGlyph(INSTextInputClient)
GetUnionRectInVisibleSelectedRange(INSTextInputClient)
GetWindowLevel(INSTextInputClient)
InsertAdaptiveImageGlyph(INSTextInputClient, NSAdaptiveImageGlyph, NSRange)
GetHandle(INativeObject)
GetNonNullHandle(INativeObject, String)

Applies to

Share via