Merge pull request #2701 from M-Lipin/dev/v-milipi/Issue_1588_TextPatternProviders

Author: RussKie

src/System.Windows.Forms.Primitives/src/Interop/Richedit/Interop.SCF.cs

@@ -11,15 +11,15 @@ internal static partial class Richedit
         [Flags]
         public enum SCF : uint
         {
-            SELECTION = 0x0001,
-            WORD = 0x0002,
-            DEFAULT = 0x0000,
-            ALL = 0x0004,
-            USEUIRULES = 0x0008,
-            ASSOCIATEFONT = 0x0010,
-            NOKBUPDATE = 0x0020,
-            ASSOCIATEFONT2 = 0x0040,
-            SMARTFONT = 0x0080,
+            DEFAULT         = 0x0000,
+            SELECTION       = 0x0001,
+            WORD            = 0x0002,
+            ALL             = 0x0004,
+            USEUIRULES      = 0x0008,
+            ASSOCIATEFONT   = 0x0010,
+            NOKBUPDATE      = 0x0020,
+            ASSOCIATEFONT2  = 0x0040,
+            SMARTFONT       = 0x0080,
             CHARREPFROMLCID = 0x0100,
         }
     }

src/System.Windows.Forms.Primitives/src/Interop/UiaCore/Interop.ITextProvider.cs

@@ -0,0 +1,30 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System.Drawing;
+using System.Runtime.InteropServices;
+
+internal static partial class Interop
+{
+    internal static partial class UiaCore
+    {
+        [ComImport]
+        [Guid("3589c92c-63f3-4367-99bb-ada653b77cf2")]
+        [InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
+        public interface ITextProvider
+        {
+            ITextRangeProvider[]? GetSelection();
+
+            ITextRangeProvider[]? GetVisibleRanges();
+
+            ITextRangeProvider? RangeFromChild(IRawElementProviderSimple childElement);
+
+            ITextRangeProvider? RangeFromPoint(Point screenLocation);
+
+            ITextRangeProvider? DocumentRange { get; }
+
+            SupportedTextSelection SupportedTextSelection { get; }
+        }
+    }
+}

src/System.Windows.Forms.Primitives/src/Interop/UiaCore/Interop.ITextProvider2.cs

@@ -0,0 +1,34 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System.Drawing;
+using System.Runtime.InteropServices;
+
+internal static partial class Interop
+{
+    internal static partial class UiaCore
+    {
+        [ComImport]
+        [Guid("0dc5e6ed-3e16-4bf1-8f9a-a979878bc195")]
+        [InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
+        public interface ITextProvider2 : ITextProvider
+        {
+            new ITextRangeProvider[]? GetSelection();
+
+            new ITextRangeProvider[]? GetVisibleRanges();
+
+            new ITextRangeProvider? RangeFromChild(IRawElementProviderSimple childElement);
+
+            new ITextRangeProvider? RangeFromPoint(Point screenLocation);
+
+            new ITextRangeProvider? DocumentRange { get; }
+
+            new SupportedTextSelection SupportedTextSelection { get; }
+
+            ITextRangeProvider? RangeFromAnnotation(IRawElementProviderSimple annotation);
+
+            ITextRangeProvider? GetCaretRange(out BOOL isActive);
+        }
+    }
+}

src/System.Windows.Forms.Primitives/src/Interop/UiaCore/Interop.ITextRangeProvider.cs

@@ -0,0 +1,53 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System.Runtime.InteropServices;
+
+internal static partial class Interop
+{
+    internal static partial class UiaCore
+    {
+        [ComImport]
+        [Guid("5347ad7b-c355-46f8-aff5-909033582f63")]
+        [InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
+        public interface ITextRangeProvider
+        {
+            ITextRangeProvider Clone();
+
+            BOOL Compare(ITextRangeProvider range);
+
+            int CompareEndpoints(TextPatternRangeEndpoint endpoint, ITextRangeProvider targetRange, TextPatternRangeEndpoint targetEndpoint);
+
+            void ExpandToEnclosingUnit(TextUnit unit);
+
+            ITextRangeProvider? FindAttribute(int attribute, object value, BOOL backward);
+
+            ITextRangeProvider? FindText(string text, BOOL backward, BOOL ignoreCase);
+
+            object? GetAttributeValue(int attribute);
+
+            double[] GetBoundingRectangles();
+
+            IRawElementProviderSimple GetEnclosingElement();
+
+            string GetText(int maxLength);
+
+            int Move(TextUnit unit, int count);
+
+            int MoveEndpointByUnit(TextPatternRangeEndpoint endpoint, TextUnit unit, int count);
+
+            void MoveEndpointByRange(TextPatternRangeEndpoint endpoint, ITextRangeProvider targetRange, TextPatternRangeEndpoint targetEndpoint);
+
+            void Select();
+
+            void AddToSelection();
+
+            void RemoveFromSelection();
+
+            void ScrollIntoView(BOOL alignToTop);
+
+            IRawElementProviderSimple[] GetChildren();
+        }
+    }
+}

src/System.Windows.Forms.Primitives/src/Interop/UiaCore/Interop.SupportedTextSelection.cs

@@ -0,0 +1,19 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System;
+
+internal static partial class Interop
+{
+    internal static partial class UiaCore
+    {
+        [Flags]
+        public enum SupportedTextSelection
+        {
+            None = 0,
+            Single = 1,
+            Multiple = 2
+        }
+    }
+}

src/System.Windows.Forms.Primitives/src/Interop/UiaCore/Interop.TextAttributeIdentifier.cs

@@ -0,0 +1,56 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+internal static partial class Interop
+{
+    internal static partial class UiaCore
+    {
+        public enum TextAttributeIdentifier
+        {
+            AnimationStyleAttributeId = 40000,
+            BackgroundColorAttributeId = 40001,
+            BulletStyleAttributeId = 40002,
+            CapStyleAttributeId = 40003,
+            CultureAttributeId = 40004,
+            FontNameAttributeId = 40005,
+            FontSizeAttributeId = 40006,
+            FontWeightAttributeId = 40007,
+            ForegroundColorAttributeId = 40008,
+            HorizontalTextAlignmentAttributeId = 40009,
+            IndentationFirstLineAttributeId = 40010,
+            IndentationLeadingAttributeId = 40011,
+            IndentationTrailingAttributeId = 40012,
+            IsHiddenAttributeId = 40013,
+            IsItalicAttributeId = 40014,
+            IsReadOnlyAttributeId = 40015,
+            IsSubscriptAttributeId = 40016,
+            IsSuperscriptAttributeId = 40017,
+            MarginBottomAttributeId = 40018,
+            MarginLeadingAttributeId = 40019,
+            MarginTopAttributeId = 40020,
+            MarginTrailingAttributeId = 40021,
+            OutlineStylesAttributeId = 40022,
+            OverlineColorAttributeId = 40023,
+            OverlineStyleAttributeId = 40024,
+            StrikethroughColorAttributeId = 40025,
+            StrikethroughStyleAttributeId = 40026,
+            TabsAttributeId = 40027,
+            TextFlowDirectionsAttributeId = 40028,
+            UnderlineColorAttributeId = 40029,
+            UnderlineStyleAttributeId = 40030,
+            AnnotationTypesAttributeId = 40031,
+            AnnotationObjectsAttributeId = 40032,
+            StyleNameAttributeId = 40033,
+            StyleIdAttributeId = 40034,
+            LinkAttributeId = 40035,
+            IsActiveAttributeId = 40036,
+            SelectionActiveEndAttributeId = 40037,
+            CaretPositionAttributeId = 40038,
+            CaretBidiModeAttributeId = 40039,
+            LineSpacingAttributeId = 40040,
+            BeforeParagraphSpacingAttributeId = 40041,
+            AfterParagraphSpacingAttributeId = 40042
+        }
+    }
+}

src/System.Windows.Forms.Primitives/src/Interop/UiaCore/Interop.TextPatternRangeEndpoint.cs

@@ -0,0 +1,18 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System;
+using System.Runtime.InteropServices;
+
+internal static partial class Interop
+{
+    internal static partial class UiaCore
+    {
+        public enum TextPatternRangeEndpoint
+        {
+            Start = 0,
+            End = 1
+        }
+    }
+}

src/System.Windows.Forms.Primitives/src/Interop/UiaCore/Interop.TextUnit.cs

@@ -0,0 +1,22 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System.Runtime.InteropServices;
+
+internal static partial class Interop
+{
+    internal static partial class UiaCore
+    {
+        public enum TextUnit
+        {
+            Character = 0,
+            Format = 1,
+            Word = 2,
+            Line = 3,
+            Paragraph = 4,
+            Page = 5,
+            Document = 6
+        }
+    }
+}

src/System.Windows.Forms.Primitives/src/Interop/UiaCore/Interop.UiaCoreTypes.cs

@@ -0,0 +1,26 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System.Runtime.InteropServices;
+
+internal static partial class Interop
+{
+    internal static partial class UiaCore
+    {
+        private static object? s_notSupportedValue;
+
+        [DllImport(Libraries.UiaCore, ExactSpelling = true)]
+        private static extern int UiaGetReservedNotSupportedValue([MarshalAs(UnmanagedType.IUnknown)] out object notSupportedValue);
+
+        public static object UiaGetReservedNotSupportedValue()
+        {
+            if (s_notSupportedValue == null)
+            {
+                UiaGetReservedNotSupportedValue(out s_notSupportedValue);
+            }
+
+            return s_notSupportedValue;
+        }
+    }
+}

src/System.Windows.Forms.Primitives/src/Interop/User32/Interop.Atom.cs

@@ -0,0 +1,32 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System;
+
+internal static partial class Interop
+{
+    /// <summary>
+    ///  Simple wrapper for an ATOM
+    /// </summary>
+    public struct Atom
+    {
+        // #define MAXINTATOM 0xC000
+        // #define MAKEINTATOM(i)  (LPTSTR)((ULONG_PTR)((WORD)(i)))
+        // #define INVALID_ATOM ((ATOM)0)
+
+        // Strange uses for window class atoms
+        // https://blogs.msdn.microsoft.com/oldnewthing/20080501-00/?p=22503/
+
+        public ushort ATOM;
+
+        public Atom(ushort atom) => ATOM = atom;
+
+        public static Atom Null = new Atom(0);
+
+        public bool IsValid => ATOM != 0;
+
+        public static implicit operator uint(Atom atom) => atom.ATOM;
+        public static implicit operator Atom(IntPtr atom) => new Atom((ushort)atom);
+    }
+}