Informationen zum Textobjektmodell

Das Text object Model (TOM) definiert eine Reihe von Textbearbeitungsschnittstellen, die in unterschiedlichem Maße von mehreren Microsoft-Textlösungen unterstützt werden, einschließlich des umfangreichen Bearbeitungssteuerelements. Dieses Thema bietet eine allgemeine Übersicht über das Inhaltsverzeichnis. Es werden die folgenden Themen erläutert.

• TOM Version 2-Objekte
• TOM-Schnittstellenkonventionen
• Der tomBool-Typ
• Mathematischer Aufbau und Aufbau
• TOM RTF
• Suchen nach Rich Text
• TOM-Barrierefreiheit
  • Schnittstelle aus ausgeführter Objekttabelle
  • Schnittstelle aus Fenstermeldungen
  • Barrierefreiheitsorientierte Methoden
• Zeichen-Übereinstimmungssätze

TOM Version 2-Objekte

TOM Version 2 (TOM 2) erweitert das ursprüngliche Textobjektmodell; die neuen Schnittstellen werden von den alten abgeleitet. Die aktualisierte TOM-API bietet Unterstützung für neue Zeichen- und Absatzformateigenschaften, ein Tabellenmodell, Mehrfachauswahl und Inlineobjektunterstützung für Mathematik und Ruby.

Das TOM 2-Objekt der obersten Ebene wird von der ITextDocument2-Schnittstelle definiert, die Methoden zum Erstellen und Abrufen von Objekten in der Objekthierarchie enthält. Für die einfache Nur-Text-Verarbeitung können Sie ein ITextRange2-Objekt aus einem ITextDocument2-Objekt abrufen und die meisten Aktionen damit ausführen. Wenn Sie Rich-Text-Formatierungen hinzufügen müssen, können Sie ITextFont2 - und ITextPara2-Objekte aus einem ITextRange2-Objekt abrufen. ITextFont2 stellt das Programmieräquivalent des Dialogfelds "Format-Schriftart" von Microsoft Word bereit, und ITextPara2 stellt das Äquivalent des dialogfelds Word Formatabsatz bereit.

Zusätzlich zu diesen drei Objekten auf niedrigerer Ebene verfügt TOM 2 über ein Auswahlobjekt (ITextSelection2), bei dem es sich um ein ITextRange2-Objekt mit Auswahlherunterhebung und einigen UI-orientierten Methoden handelt.

Die Bereichs- und Auswahlobjekte umfassen bildschirmorientierte Methoden, mit denen Programme Text auf dem Bildschirm oder Text untersuchen können, der auf den Bildschirm scrollen kann. Diese Funktionen helfen beispielsweise, Text für Menschen mit Sehbehinderung zugänglich zu machen.

Jede Schnittstelle mit dem Suffix 2 erbt von der entsprechenden Schnittstelle ohne das Suffix 2. Beispielsweise erbt ITextDocument2 von ITextDocument.

Die TOM 2-Objekte weisen die folgende Hierarchie auf.

ITextDocument2         Top-level editing object
    ITextRange2        Primary text interface: a range of text
        ITextFont2     Character-attribute interface
        ITextPara2     Paragraph-attribute interface
        ITextRow       Table interface
    ITextSelection2    Screen highlighted text range
        ITextRange2    Selection inherits all range methods
    ITextDisplays      Displays collection (not yet defined)
    ITextStrings       Rich-text strings collection
    ITextStoryRanges2  Enumerator for stories in document

Ein ITextDocument2-Objekt beschreibt einen oder mehrere zusammenhängende Textbereiche, die als Stories bezeichnet werden. Storys stellen verschiedene Teile eines Dokuments dar, z. B. den Standard Text des Dokuments, Kopf- und Fußzeilen, Fußnoten, Anmerkungen und Rich-Text-Scratchpads. Bei der Übersetzung zwischen linear formatierten mathematischen Ausdrücken und einem integrierten Formular wird ein Scratchpad-Story verwendet. Ein Scratchpad-Story wird auch verwendet, wenn der Inhalt eines Bereichs gespeichert wird, der die aktuelle Kopierquelle ist, wenn der Inhalt geändert werden soll.

Ein ITextRange2-Objekt wird durch seine Anfangs- und Endzeichenpositionsoffsets und ein Story-Objekt definiert. Es ist nicht unabhängig von seinem übergeordneten Storyobjekt vorhanden, obwohl sein Text in die Zwischenablage oder auf andere Ziele kopiert werden kann. Ein Textbereichsobjekt unterscheidet sich von tabellenkalkulations- und anderen Bereichsobjekten, die durch andere Arten von Offsets definiert werden. z. B. Zeile/Spalte oder Grafikposition (x, y). Ein Textbereichsobjekt kann sich auf verschiedene Weise ändern, ein Duplikat von sich selbst zurückgeben, und es kann aufgefordert werden, seine Anfangs- und Endzeichenpositionen und seinen Story-Zeiger auf die aktuelle Auswahl zu kopieren.

Ein explizites Story-Objekt ist nicht erforderlich, da ein ITextRange-Objekt immer erstellt werden kann, um eine bestimmte Story darzustellen. Insbesondere kann das ITextDocument-Objekt ein ITextStoryRanges-Objekt erstellen, um die Storys im Dokument in Bezug auf Bereiche mit Anfangs- und Endzeichenpositionswerten aufzulisten, die vollständige Geschichten beschreiben (z. B. 0 und tomForward).

Bei einem ITextStoryRanges2-Objekt ist kein explizites Storyobjekt erforderlich, da die einzelnen Storys von einem ITextRange2-Objekt beschrieben werden. Insbesondere kann das ITextDocument2-Objekt ein ITextStoryRanges2-Objekt erstellen, um die Storys im Dokument in Bezug auf Bereiche mit Anfangs- und Endzeichenpositionswerten aufzulisten, die vollständige Geschichten beschreiben (z. B. 0 und tomForward).

Die ITextRow-Schnittstelle zusammen mit den Methoden ITextRange::Move und ITextRange::Expand ermöglicht das Einfügen, Abfragen und Ändern von Tabellen.

TOM-Schnittstellenkonventionen

Alle TOM-Methoden geben HRESULT-Werte zurück. Im Allgemeinen geben die TOM-Methoden die folgenden Standardwerte zurück.

• E_OUTOFMEMORY
• E_INVALIDARG
• E_NOTIMPL
• E_FILENOTFOUND
• E_ACCESSDENIED
• E_FAIL
• CO_E_RELEASED
• NOERROR (identisch mit S_OK)
• S_FALSE

Beachten Sie, dass das TOM-Objekt nutzlos wird, wenn die bearbeitungsbezogene instance, die einem TOM-Objekt wie ITextRange zugeordnet ist, gelöscht wird, und alle seine Methoden CO_E_RELEASED zurückgeben.

Zusätzlich zu den HRESULT-Rückgabewerten enthalten viele Methoden out-Parameter, bei denen es sich um Zeiger handelt, die zum Zurückgeben von Werten verwendet werden. Für alle Schnittstellen sollten Sie alle Zeigerparameter überprüfen, um sicherzustellen, dass sie ungleich null sind, bevor Sie sie verwenden. Wenn Sie einen NULL-Wert an eine Methode übergeben, die einen gültigen Zeiger erfordert, gibt die Methode E_INVALIDARG zurück. Optionale Out-Zeiger mit NULL-Werten werden ignoriert.

Verwenden Sie Methoden mit Get- und Set-Präfixen, um Eigenschaften abzurufen und festzulegen. Boolesche Variablen verwenden tomFalse (0) für FALSE und tomTrue (-1) für TRUE.

TOM-Konstanten werden im TomConstants-Enumerationstyp definiert und beginnen mit dem Präfix tom, z. B. tomWord.

Der tomBool-Typ

Viele TOM-Methoden verwenden einen speziellen Typ von Variablen namens "tomBool" für Rich-Text-Attribute mit binären Zuständen. Der TomBool-Typ unterscheidet sich vom booleschen Typ, da er vier Werte annehmen kann: tomTrue, tomFalse, tomToggle und tomUndefined. Die Werte tomTrue und tomFalse geben true und false an. Der tomToggle-Wert wird verwendet, um eine Eigenschaft umzuschalten. Der tomUndefined-Wert , üblicher als NINCH bezeichnet, ist ein spezieller No-Input-, No-Change-Wert, der mit Longs, floats und COLORREFs funktioniert. Bei Zeichenfolgen wird tomUndefined (oder NINCH) durch die NULL-Zeichenfolge dargestellt. Bei Eigenschafteneinstellungsvorgängen ändert die Verwendung von tomUndefined nicht die Zieleigenschaft. Bei Vorgängen zum Abrufen von Eigenschaften bedeutet tomUndefined , dass die Zeichen im Bereich unterschiedliche Werte aufweisen (es wird das abgeblendete Kontrollkästchen in Eigenschaftendialogfeldern angezeigt).

Mathematischer Aufbau und Aufbau

Sie können die ITextRange2::BuildUpMath-Methode verwenden, um linear formatierte mathematische Ausdrücke in integrierte Versionen zu konvertieren. Die ITextRange2::Linearize-Methode führt die entgegengesetzte Konvertierung durch, die als Linearisierung oder Builddown bezeichnet wird, um erstellte Versionen von mathematischen Ausdrücken wieder in das lineare Format zu konvertieren. Die Mathematische Builddownfunktion ist nützlich, wenn Sie Nur-Text exportieren oder bestimmte Bearbeitungstypen aktivieren müssen.

TOM RTF

In TOM kann der Rich-Text-Austausch durch Sätze expliziter Methodenaufrufe oder durch Übertragungen von Rich-Text im Rich-Text-Format (RTF) erreicht werden. Dieser Abschnitt enthält Tabellen mit RTF-Steuerelementwörtern für Absatzeigenschaften und für Zeicheneigenschaften.

TOM RTF Paragraph Control Wörter

TOM RTF-Zeichenformat-Steuerelementwörter

Suchen nach Rich Text

Sie können TOM-Methoden verwenden, um Rich-Text zu finden, der durch einen Textbereich definiert ist. Die genaue Suche nach einem solchen Rich-Text wird in der Textverarbeitung häufig benötigt, obwohl es in einer WySIWYG-Textverarbeitung (Was Sie sehen, was Sie sehen, was Sie erhalten) noch nie erfüllt wurde. Es gibt eindeutig eine größere Domäne des Rich-Text-Abgleichs, die es ermöglicht, dass einige Zeichenformatierungseigenschaften ignoriert werden (oder Absatzformatierung und/oder Objektinhalt eingeschlossen werden), aber solche Generalisierungen sprengen den Bereich dieses Abschnitts.

Ein Zweck für diese Funktion besteht darin, ein Rich-Text-Suchen-Dialogfeld zu verwenden, um den Rich-Text zu definieren, den Sie in einem Dokument suchen möchten. Das Dialogfeld wird mithilfe eines Rich-Edit-Steuerelements implementiert, und TOM-Methoden würden verwendet, um die Suche durch das Dokument durchzuführen. Sie können entweder den gewünschten Rich-Text aus dem Dokument in das Dialogfeld Suchen kopieren oder ihn direkt im Dialogfeld Suchen eingeben und formatieren.

Im folgenden Beispiel wird gezeigt, wie Sie mithilfe von TOM-Methoden nach Text suchen, der Kombinationen der exakten Zeichenformatierung enthält. Der Algorithmus sucht den Nur-Text im Übereinstimmungsbereich mit dem Namen pr1. Wenn der Nur-Text gefunden wird, wird von einem Testbereich mit dem Namen pr2darauf verwiesen. Anschließend werden zwei Einfügemarkesbereiche (prip1 und prip2) verwendet, um den Testbereich zu durchlaufen, um seine Zeichenformatierung mit der von pr1zu vergleichen. Wenn sie genau übereinstimmen, wird der Eingabebereich (angegeben durch ppr) aktualisiert, um auf den Text des Testbereichs zu verweisen, und die Funktion gibt die Anzahl der Zeichen im übereinstimmenden Bereich zurück. Beim Vergleich der Zeichenformatierung werden zwei ITextFont-Objektepf1 und pf2verwendet. Sie sind an die Einfügemarkesbereiche prip1 und prip2angefügt.

LONG FindRichText (
    ITextRange **ppr,             // Ptr to range to search
    ITextRange *pr1)              // Range with rich text to find
{
    BSTR        bstr;             // pr1 plain-text to search for
    LONG        cch;              // Text string count
    LONG        cch1, cch2;       // tomCharFormat run char counts
    LONG        cchMatch = 0;     // Nothing matched yet
    LONG        cp;               // Handy char position
    LONG        cpFirst1;         // pr1 cpFirst
    LONG        cpFirst2;         // pr2 cpFirst
    ITextFont  *    pf1, *pf      // Fonts corresponding to IPs prip1 and prip2
    ITextRange *pr2;              // Range duplicate to search with
    ITextRange *prip1, *prip      // Insertion points to walk pr1, pr2

    if (!ppr || !*ppr || !pr1)
        return E_INVALIDARG;

    // Initialize range and font objects used in search
    if ((*ppr)->GetDuplicate(&pr2)    != NOERROR ||
        pr1->GetDuplicate(&prip1)     != NOERROR ||
        pr2->GetDuplicate(&prip2)     != NOERROR ||
        prip1->GetFont(&pf1)          != NOERROR ||
        prip2->GetFont(&pf2)          != NOERROR ||
        pr1->GetText(&bstr)           != NOERROR )
    {
        return E_OUTOFMEMORY;
    }

    pr1->GetStart(&cpFirst1);

    // Keep searching till rich text is matched or no more plain-text hits
    while(!cchMatch && pr2->FindText(bstr, tomForward, 0, &cch) == NOERROR)
    {
        pr2->GetStart(&cpFirst2);                 // pr2 is a new trial range
        prip1->SetRange(cpFirst1, cpFirst1);      // Set up IPs to scan match
        prip2->SetRange(cpFirst2, cpFirst2);      //  and trial ranges

        while(cch > 0 &&
            pf1->IsEqual(pf2, NULL) == NOERROR)   // Walk match & trial ranges
        {                                         //  together comparing font
            prip1->GetStart(&cch1);               //  properties
            prip1->Move(tomCharFormat, 1, NULL);
            prip1->GetStart(&cp);
            cch1 = cp - cch1;                     // cch of next match font run

            prip2->GetStart(&cch2);
            prip2->Move(tomCharFormat, 1, NULL);
            prip2->GetStart(&cp);
            cch2 = cp - cch2;                      // cch of next trial font run

            if(cch1 < cch)                         // There is more to compare
            {
                if(cch1 != cch2)                   // Different run lengths:
                    break;                         //  no formatting match
                cch = cch - cch1;                  // Matched format run
            }
            else if(cch2 < cch)                    // Trial range format run too
                break;                             //  short

            else                                   // Both match and trial runs
            {                                      //  reach at least to match
                pr2->GetEnd(&cp);                  //  text end: rich-text match
                (*ppr)->SetRange(cpFirst2, cp)     // Set input range to hit
                cchMatch = cp - cpFirst2;          //  coordinates and return
                break;                             //  length of matched string
            }
        }
    }
    pr2->Release();
    prip1->Release();
    prip2->Release();
    pf1->Release();
    pf2->Release();
    SysFreeString(bstr);

    return cchMatch;
}

TOM-Barrierefreiheit

TOM bietet Unterstützung für Barrierefreiheit über die Schnittstellen ITextSelection und ITextRange . In diesem Abschnitt werden Methoden beschrieben, die für die Barrierefreiheit nützlich sind, und wie ein Programm die x-, y-Bildschirmposition eines Objekts bestimmen kann.

Da benutzeroberflächenbasierte Barrierefreiheitsprogramme in der Regel mit dem Bildschirm und der Maus arbeiten, besteht ein häufiges Problem darin, die entsprechende ITextDocument-Schnittstelle für die aktuelle Mausposition (in Bildschirmkoordinaten) zu finden. In den folgenden Abschnitten werden zwei Möglichkeiten zum Ermitteln der richtigen Schnittstelle beschrieben:

• Über die Tabelle running-object
• Über die EM_GETOLEINTERFACE-Nachricht , die für Rich-Edit-Instanzen mit Fenstern funktioniert, vorausgesetzt, der Client befindet sich im selben Prozessbereich (kein Marshalling ist erforderlich).

Weitere Informationen finden Sie in der Microsoft Active-Barrierefreiheitsspezifikation. Nachdem Sie ein Objekt aus einer Bildschirmposition abgerufen haben, können Sie für eine ITextDocument-Schnittstelle verwenden und die RangeFromPoint-Methode aufrufen, um ein leeres Bereichsobjekt am cp zu erhalten, das der Bildschirmposition entspricht.

Schnittstelle aus ausführenden Objekttabellen

Eine laufende Objekttabelle (ROT) gibt an, welche Objektinstanzen aktiv sind. Durch Abfragen dieser Tabelle können Sie den Prozess der Verbindung eines Clients mit einem Objekt beschleunigen, wenn das Objekt bereits ausgeführt wird. Bevor Programme über die ausgeführte Objekttabelle auf TOM-Schnittstellen zugreifen können, muss ein TOM-instance mit einem Fenster in der ROT-Instanz mit einem Moniker registriert werden. Sie erstellen den Moniker aus einer Zeichenfolge, die den Hexadezimalwert ihres HWND enthält. Im folgenden Codebeispiel wird gezeigt, wie dies geschieht.

// This TOM implementation code is executed when a new windowed 
// instance starts up. 
// Variables with leading underscores are members of this class.

HRESULT hr;
OLECHAR szBuf[10];            // Place to put moniker
MONIKER *pmk;

hr = StringCchPrintf(szBuff, 10, "%x", _hwnd);
if (FAILED(hr))
{
    //
    // TODO: write error handler
    //
}
CreateFileMoniker(szBuf, &pmk);
OleStdRegisterAsRunning(this, pmk, &_dwROTcookie);
....................
 
// Accessibility Client: 
//    Find hwnd for window pointed to by mouse cursor.

GetCursorPos(&pt);
hwnd = WindowFromPoint(pt);

// Look in ROT (running object table) for an object attached to hwnd

hr = StringCchPrintf(szBuff, 10, "%x", hwnd);
if (FAILED(hr))
{
    //
    // TODO: write error handler
    //
}
CreateFileMoniker(szBuf, &pmk);
CreateBindContext(0, &pbc);
pmk->BindToObject(pbc, NULL, IID_ITextDocument, &pDoc);
pbc->Release();

if( pDoc )
{
    pDoc->RangeFromPoint(pt.x, pt.y, &pRange);
    // ...now do whatever with the range pRange
}

Schnittstelle aus Fenstermeldungen

Die EM_GETOLEINTERFACE Meldung bietet eine weitere Möglichkeit, eine IUnknown-Schnittstelle für ein Objekt an einer bestimmten Bildschirmposition abzurufen. Wie unter Interface from Running Object Table beschrieben, erhalten Sie eine HWND für die Bildschirmposition und senden diese Nachricht dann an diese HWND. Die EM_GETOLEINTERFACE Nachricht ist rich edit-specific und gibt einen Zeiger auf eine IRichEditOle-Schnittstelle in der Variablen zurück, die von lParam adressiert wird.

Tipp Wenn ein Zeiger zurückgegeben wird (stellen Sie sicher, dass Sie das Objekt festlegen, auf das lParam vor dem Senden der Nachricht auf NULL zeigt), können Sie die IUnknown::QueryInterface-Methode aufrufen, um eine ITextDocument-Schnittstelle abzurufen. Das folgende Codebeispiel veranschaulicht diese Vorgehensweise.

    HWND    hwnd;
    ITextDocument *pDoc;
    ITextRange *pRange;
    POINT    pt;
    IUnknown *pUnk = NULL;
    
    GetCursorPos(&pt);
    hwnd = WindowFromPoint(pt);
    SendMessage(hwnd, EM_GETOLEINTERFACE, 0, (LPARAM)&pUnk);
    if(pUnk && 
        pUnk->QueryInterface(IID_ITextDocument, &pDoc) == NOERROR)
    {
        pDoc->RangeFromPoint(pt.x, pt.y, &pRange);
        //  ... continue with rest of program
    }

Barrierefreiheitsorientierte Methoden

Einige TOM-Methoden sind besonders nützlich für die Navigation auf dem Bildschirm, während andere TOM-Methoden verbessern, was Sie tun können, wenn Sie an Sehenswürdigkeiten ankommen. In der folgenden Tabelle werden die nützlichsten Methoden beschrieben.

Zeichensätze

Der Variant-Parameter der verschiedenen Move*-Methoden in ITextRange, z. B. MoveWhile und MoveUntil, kann eine explizite Zeichenfolge oder einen 32-Bit-Zeichensatz-Index annehmen. Die Indizes werden entweder durch Unicode-Bereiche oder GetStringTypeEx-Zeichensätze definiert. Der Unicode-Bereich ab n und der Länge l (< 32768) wird durch den Index n + (l << 16) + 0x80000000 angegeben. Beispielsweise werden grundlegende griechische Buchstaben durch CR_Greek = 0x805f0370 definiert, und druckbare ASCII-Zeichen werden durch CR_ASCIIPrint = 0x805e0020 definiert. Darüber hinaus können Sie mit den Methoden MoveWhile und MoveUntil eine Spanne von Zeichen in jedem GetStringTypeEx-Zeichensatz oder in einer Spanne von Zeichen, die sich in keinem dieser Zeichensätze befindet, schnell umgehen.

Die GetStringTypeEx-Sätze werden durch die Werte für Ctype1, Ctype2 und Ctype3 angegeben und wie folgt definiert.

Insbesondere kann Ctype1 eine beliebige Kombination der folgenden Sein.

Die Ctype2-Typen unterstützen das richtige Layout von Unicode-Text. Die Richtungsattribute werden zugewiesen, sodass der bidirektionale Layoutalgorithmus, der von Unicode standardisiert ist, genaue Ergebnisse erzeugt. Diese Typen schließen sich gegenseitig aus. Weitere Informationen zur Verwendung dieser Attribute finden Sie unter The Unicode Standard: Worldwide Character Encoding, Volume 1 and 2, Addison-Wesley Publishing Company: 1991, 1992.

Die Ctype3-Typen sind als Platzhalter für Erweiterungen der POSIX-Typen vorgesehen, die für die allgemeine Textverarbeitung oder für die Standardfunktionen der C-Bibliothek erforderlich sind.

Ein Edit Development Kit (EDK) kann pVar-Indexdefinitionen für die folgenden bereiche enthalten, die im Unicode-Standard beschrieben sind.