COleClientItem-Klasse

Artikel
10/12/2023

Definiert die Containerschnittstelle zu OLE-Elementen.

Syntax

class COleClientItem : public CDocItem

Member

Öffentliche Konstruktoren

Name	Beschreibung
COleClientItem::COleClientItem	Erstellt ein `COleClientItem`-Objekt.

Öffentliche Methoden

Name	Beschreibung
COleClientItem::Activate	Öffnet das OLE-Element für einen Vorgang und führt dann das angegebene Verb aus.
COleClientItem::ActivateAs	Aktiviert das Element als anderen Typ.
COleClientItem::AttachDataObject	Greift auf die Daten im OLE-Objekt zu.
COleClientItem::CanCreateFromData	Gibt an, ob eine Containeranwendung ein eingebettetes Objekt erstellen kann.
COleClientItem::CanCreateLinkFromData	Gibt an, ob eine Containeranwendung ein verknüpftes Objekt erstellen kann.
COleClientItem::CanPaste	Gibt an, ob die Zwischenablage ein einbettbares oder statisches OLE-Element enthält.
COleClientItem::CanPasteLink	Gibt an, ob die Zwischenablage ein verknüpftes OLE-Element enthält.
COleClientItem::Close	Schließt eine Verknüpfung zu einem Server, zerstört aber nicht das OLE-Element.
COleClientItem::ConvertTo	Konvertiert das Element in einen anderen Typ.
COleClientItem::CopyToClipboard	Kopiert das OLE-Element in die Zwischenablage.
COleClientItem::CreateCloneFrom	Erstellt ein Duplikat eines vorhandenen Elements.
COleClientItem::CreateFromClipboard	Erstellt ein eingebettetes Element aus der Zwischenablage.
COleClientItem::CreateFromData	Erstellt ein eingebettetes Element aus einem Datenobjekt.
COleClientItem::CreateFromFile	Erstellt ein eingebettetes Element aus einer Datei.
COleClientItem::CreateLinkFromClipboard	Erstellt ein verknüpftes Element aus der Zwischenablage.
COleClientItem::CreateLinkFromData	Erstellt ein verknüpftes Element aus einem Datenobjekt.
COleClientItem::CreateLinkFromFile	Erstellt ein verknüpftes Element aus einer Datei.
COleClientItem::CreateNewItem	Erstellt ein neues eingebettetes Element durch Starten der Serveranwendung.
COleClientItem::CreateStaticFromClipboard	Erstellt ein statisches Element aus der Zwischenablage.
COleClientItem::CreateStaticFromData	Erstellt ein statisches Element aus einem Datenobjekt.
COleClientItem::D eaktivieren	Deaktiviert das Element.
COleClientItem::D eactivateUI	Stellt die Benutzeroberfläche der Containeranwendung im ursprünglichen Zustand wieder her.
COleClientItem::D elete	Löscht oder schließt das OLE-Element, wenn es sich um ein verknüpftes Element handelt.
COleClientItem::D oDragDrop	Führt einen Drag-and-Drop-Vorgang aus.
COleClientItem::D oVerb	Führt das angegebene Verb aus.
COleClientItem::D raw	Zeichnet das OLE-Element.
COleClientItem::GetActiveView	Ruft die Ansicht ab, in der das Element aktiviert ist.
COleClientItem::GetCachedExtent	Gibt die Grenzen des Rechtecks des OLE-Elements zurück.
COleClientItem::GetClassID	Ruft die Klassen-ID des aktuellen Elements ab.
COleClientItem::GetClipboardData	Ruft die Daten ab, die durch Aufrufen der `CopyToClipboard` Memberfunktion in die Zwischenablage eingefügt werden.
COleClientItem::GetDocument	Gibt das `COleDocument` Objekt zurück, das das aktuelle Element enthält.
COleClientItem::GetDrawAspect	Ruft die aktuelle Ansicht des Elements zum Rendern ab.
COleClientItem::GetExtent	Gibt die Grenzen des Rechtecks des OLE-Elements zurück.
COleClientItem::GetIconFromRegistry	Ruft ein Handle zu einem Symbol ab, das dem Server einer bestimmten CLSID zugeordnet ist.
COleClientItem::GetIconicMetafile	Ruft die Metadatei ab, die zum Zeichnen des Elements Symbol verwendet wird.
COleClientItem::GetInPlaceWindow	Gibt einen Zeiger auf das direkte Bearbeitungsfenster des Elements zurück.
COleClientItem::GetItemState	Ruft den aktuellen Status des Elements ab.
COleClientItem::GetLastStatus	Gibt den Status des letzten OLE-Vorgangs zurück.
COleClientItem::GetLinkUpdateOptions	Gibt den Aktualisierungsmodus für ein verknüpftes Element (erweitertes Feature) zurück.
COleClientItem::GetType	Gibt den Typ (eingebettet, verknüpft oder statisch) des OLE-Elements zurück.
COleClientItem::GetUserType	Ruft eine Zeichenfolge ab, die den Typ des Elements beschreibt.
COleClientItem::IsInPlaceActive	Gibt TRUE zurück, wenn das Element aktiv ist.
COleClientItem::IsLinkUpToDate	Gibt TRUE zurück, wenn ein verknüpftes Element mit seinem Quelldokument auf dem neuesten Stand ist.
COleClientItem::IsModified	Gibt TRUE zurück, wenn das Element seit dem letzten Speichern geändert wurde.
COleClientItem::IsOpen	Gibt TRUE zurück, wenn das Element derzeit in der Serveranwendung geöffnet ist.
COleClientItem::IsRunning	Gibt TRUE zurück, wenn die Serveranwendung des Elements ausgeführt wird.
COleClientItem::OnActivate	Vom Framework aufgerufen, um das Element zu benachrichtigen, dass es aktiviert ist.
COleClientItem::OnActivateUI	Wird vom Framework aufgerufen, um das Element zu benachrichtigen, dass es aktiviert ist und seine Benutzeroberfläche anzeigen soll.
COleClientItem::OnChange	Wird aufgerufen, wenn der Server das OLE-Element ändert. Implementierung erforderlich.
COleClientItem::OnDeactivate	Wird vom Framework aufgerufen, wenn ein Element deaktiviert wird.
COleClientItem::OnDeactivateUI	Wird vom Framework aufgerufen, wenn der Server seine direkte Benutzeroberfläche entfernt hat.
COleClientItem::OnGetClipboardData	Vom Framework aufgerufen, um die Daten abzurufen, die in die Zwischenablage kopiert werden sollen.
COleClientItem::OnInsertMenus	Vom Framework aufgerufen, um ein zusammengesetztes Menü zu erstellen.
COleClientItem::OnRemoveMenus	Vom Framework aufgerufen, um die Menüs des Containers aus einem zusammengesetzten Menü zu entfernen.
COleClientItem::OnSetMenu	Vom Framework aufgerufen, um ein zusammengesetztes Menü zu installieren und zu entfernen.
COleClientItem::OnShowControlBars	Vom Framework aufgerufen, um Steuerleisten ein- und auszublenden.
COleClientItem::OnUpdateFrameTitle	Wird vom Framework aufgerufen, um die Titelleiste des Rahmenfensters zu aktualisieren.
COleClientItem::ReactivateAndUndo	Reaktiviert das Element und hebt den letzten direkten Bearbeitungsvorgang zurück.
COleClientItem::Release	Gibt die Verbindung mit einem verknüpften OLE-Element frei und schließt sie, wenn es geöffnet war. Das Clientelement wird nicht zerstört.
COleClientItem::Reload	Lädt das Element nach einem Aufruf neu.`ActivateAs`
COleClientItem::Run	Führt die anwendung aus, die dem Element zugeordnet ist.
COleClientItem::SetDrawAspect	Legt die aktuelle Ansicht des Elements für das Rendern fest.
COleClientItem::SetExtent	Legt das umgebende Rechteck des OLE-Elements fest.
COleClientItem::SetHostNames	Legt die Namen fest, die der Server beim Bearbeiten des OLE-Elements anzeigt.
COleClientItem::SetIconicMetafile	Speichert die metadatei zwischen, die zum Zeichnen des Elementssymbols verwendet wird.
COleClientItem::SetItemRects	Legt das umgebende Rechteck des Elements fest.
COleClientItem::SetLinkUpdateOptions	Legt den Updatemodus für ein verknüpftes Element (erweitertes Feature) fest.
COleClientItem::SetPrintDevice	Legt das Druckzielgerät für dieses Clientelement fest.
COleClientItem::UpdateLink	Aktualisiert den Präsentationscache eines Elements.

Geschützte Methoden

Name	Beschreibung
COleClientItem::CanActivate	Vom Framework aufgerufen, um zu bestimmen, ob die direkte Aktivierung zulässig ist.
COleClientItem::OnChangeItemPosition	Wird vom Framework aufgerufen, wenn sich die Position eines Elements ändert.
COleClientItem::OnDeactivateAndUndo	Wird vom Framework aufgerufen, um nach der Aktivierung rückgängig zu machen.
COleClientItem::OnDiscardUndoState	Vom Framework aufgerufen, um die Statusinformationen des Elements rückgängig zu machen.
COleClientItem::OnGetClipRect	Vom Framework aufgerufen, um die Clipping-Rechteckkoordinaten des Elements abzurufen.
COleClientItem::OnGetItemPosition	Wird vom Framework aufgerufen, um die Position des Elements relativ zur Ansicht abzurufen.
COleClientItem::OnGetWindowContext	Wird vom Framework aufgerufen, wenn ein Element aktiviert wird.
COleClientItem::OnScrollBy	Vom Framework aufgerufen, um das Element in die Ansicht zu scrollen.
COleClientItem::OnShowItem	Vom Framework aufgerufen, um das OLE-Element anzuzeigen.

Hinweise

Ein OLE-Element stellt Daten dar, die von einer Serveranwendung erstellt und verwaltet werden, die "nahtlos" in ein Dokument integriert werden kann, sodass es dem Benutzer als einzelnes Dokument erscheint. Das Ergebnis ist ein "zusammengesetztes Dokument" aus dem OLE-Element und einem enthaltenden Dokument.

Ein OLE-Element kann entweder eingebettet oder verknüpft werden. Wenn sie eingebettet ist, werden die Daten als Teil des Verbunddokuments gespeichert. Wenn sie verknüpft ist, werden die Daten als Teil einer separaten Datei gespeichert, die von der Serveranwendung erstellt wurde, und nur eine Verknüpfung zu dieser Datei wird im Verbunddokument gespeichert. Alle OLE-Elemente enthalten Informationen, die die Serveranwendung angeben, die aufgerufen werden soll, um sie zu bearbeiten.

COleClientItem definiert mehrere überschreibbare Funktionen, die als Reaktion auf Anforderungen von der Serveranwendung aufgerufen werden; Diese Außerkraftsetzungen dienen in der Regel als Benachrichtigungen. Auf diese Weise kann die Serveranwendung den Container über Änderungen informieren, die der Benutzer beim Bearbeiten des OLE-Elements vor nimmt, oder informationen abrufen, die während der Bearbeitung erforderlich sind.

COleClientItemkann entweder mit der COleDocument-, COleLinkingDoc- oder COleServerDoc-Klasse verwendet werden. COleClientItemUm eine Klasse davon abzuleiten und die OnChange-Memberfunktion zu implementieren, die definiert, wie der Container auf Änderungen reagiert, die an dem Element vorgenommen wurden. Um die direkte Aktivierung zu unterstützen, überschreiben Sie die OnGetItemPosition-Memberfunktion . Diese Funktion enthält Informationen zur angezeigten Position des OLE-Elements.

Weitere Informationen zur Verwendung der Containerschnittstelle finden Sie in den Artikeln Container: Implementieren eines Containers und einer Aktivierung.

Hinweis

Das Windows SDK bezieht sich auf eingebettete und verknüpfte Elemente als "Objekte" und verweist auf Elementtypen als "Klassen". In diesem Verweis wird der Begriff "item" verwendet, um die OLE-Entität vom entsprechenden C++-Objekt und dem Begriff "type" zu unterscheiden, um die OLE-Kategorie von der C++-Klasse zu unterscheiden.

Vererbungshierarchie

CObject

CCmdTarget

CDocItem

COleClientItem

Anforderungen

Kopfzeile: afxole.h

COleClientItem::Activate

Rufen Sie diese Funktion auf, um das angegebene Verb anstelle von DoVerb auszuführen, damit Sie ihre eigene Verarbeitung ausführen können, wenn eine Ausnahme ausgelöst wird.

void Activate(
    LONG nVerb,
    CView* pView,
    LPMSG lpMsg = NULL);

Parameter

nVerb
Gibt das auszuführende Verb an. Folgende Werte sind möglich:

Wert	Bedeutung	Symbol
- 0	Primäres Verb	OLEIVERB_PRIMARY
- 1	Sekundäres Verb	(Keine)
- 1	Element zum Bearbeiten anzeigen	OLEIVERB_SHOW
- 2	Element in separatem Fenster bearbeiten	OLEIVERB_OPEN
- 3	Element ausblenden	OLEIVERB_HIDE

Der -1-Wert ist in der Regel ein Alias für ein anderes Verb. Wenn die Bearbeitung nicht unterstützt wird, hat -2 die gleiche Wirkung wie -1. Weitere Werte finden Sie unter "IOleObject::D oVerb " im Windows SDK.

pView
Zeigen Sie auf das Containeransichtsfenster, das das OLE-Element enthält. dies wird von der Serveranwendung für die direkte Aktivierung verwendet. Dieser Parameter sollte NULL sein, wenn der Container die direkte Aktivierung nicht unterstützt.

lpMsg
Zeigen Sie auf die Nachricht, die dazu führte, dass das Element aktiviert wurde.

Hinweise

Wenn die Serveranwendung mithilfe der Microsoft Foundation Class Library geschrieben wurde, bewirkt diese Funktion, dass die OnDoVerb-Memberfunktion des entsprechenden COleServerItem Objekts ausgeführt wird.

Wenn das primäre Verb "Bearbeiten" und "Null" im nVerb-Parameter angegeben ist, wird die Serveranwendung gestartet, damit das OLE-Element bearbeitet werden kann. Wenn die Containeranwendung die direkte Aktivierung unterstützt, kann die Bearbeitung erfolgen. Wenn der Container die direkte Aktivierung nicht unterstützt (oder wenn das Verb "Öffnen" angegeben ist), wird der Server in einem separaten Fenster gestartet und kann dort bearbeitet werden. Wenn der Benutzer der Containeranwendung auf das OLE-Element doppelklicken, bestimmt der Wert für das primäre Verb im nVerb-Parameter , welche Aktion der Benutzer ausführen kann. Wenn der Server jedoch nur eine Aktion unterstützt, wird diese Aktion ausgeführt, unabhängig davon, welcher Wert im nVerb-Parameter angegeben ist.

Weitere Informationen finden Sie unter "IOleObject::D oVerb " im Windows SDK.

COleClientItem::ActivateAs

Verwendet die Objektkonvertierungseinrichtungen von OLE, um das Element so zu aktivieren, als ob es sich um ein Element des typs handelt, der durch clsidNew angegeben wurde.

virtual BOOL ActivateAs(
    LPCTSTR lpszUserType,
    REFCLSID clsidOld,
    REFCLSID clsidNew);

Parameter

lpszUserType
Zeigen Sie auf eine Zeichenfolge, die den Zielbenutzertyp darstellt, z. B. "Word-Dokument".

clsidOld
Ein Verweis auf die aktuelle Klassen-ID des Elements. Die Klassen-ID sollte den Typ des tatsächlichen Objekts darstellen, wie gespeichert, es sei denn, es handelt sich um eine Verknüpfung. In diesem Fall sollte es sich um die CLSID des Elements handeln, auf das sich der Link bezieht. COleConvertDialog stellt automatisch die richtige Klassen-ID für das Element bereit.

clsidNew
Ein Verweis auf die Zielklassen-ID.

Rückgabewert

Ungleich Null, wenn erfolgreich, andernfalls 0 (Null).

Hinweise

Dies wird automatisch von COleConvertDialog::D oConvert aufgerufen. Es wird in der Regel nicht direkt aufgerufen.

COleClientItem::AttachDataObject

Rufen Sie diese Funktion auf, um ein COleDataObject für den Zugriff auf die Daten im OLE-Element zu initialisieren.

void AttachDataObject(COleDataObject& rDataObject) const;

Parameter

rDataObject
Verweis auf ein COleDataObject Objekt, das initialisiert wird, um den Zugriff auf die Daten im OLE-Element zu ermöglichen.

COleClientItem::CanActivate

Wird vom Framework aufgerufen, wenn der Benutzer die direkte Aktivierung des OLE-Elements anfordert; Der Rückgabewert dieser Funktion bestimmt, ob die direkte Aktivierung zulässig ist.

virtual BOOL CanActivate();

Rückgabewert

Nonzero, wenn die direkte Aktivierung zulässig ist; andernfalls 0.

Hinweise

Die Standardimplementierung ermöglicht die direkte Aktivierung, wenn der Container über ein gültiges Fenster verfügt. Überschreiben Sie diese Funktion, um spezielle Logik zum Akzeptieren oder Ablehnen der Aktivierungsanforderung zu implementieren. Eine Aktivierungsanforderung kann z. B. verweigert werden, wenn das OLE-Element zu klein ist oder derzeit nicht sichtbar ist.

Weitere Informationen finden Sie unter "IOleInPlaceSite::CanInPlaceActivate " im Windows SDK.

COleClientItem::CanCreateFromData

Überprüft, ob eine Containeranwendung ein eingebettetes Objekt aus dem angegebenen COleDataObject Objekt erstellen kann.

static BOOL PASCAL CanCreateFromData(const COleDataObject* pDataObject);

Parameter

pDataObject
Zeiger auf das COleDataObject-Objekt , aus dem das OLE-Element erstellt werden soll.

Rückgabewert

Nonzero, wenn der Container ein eingebettetes Objekt aus dem COleDataObject Objekt erstellen kann; andernfalls 0.

Hinweise

Die COleDataObject Klasse wird bei Datenübertragungen zum Abrufen von Daten in verschiedenen Formaten aus der Zwischenablage, durch Ziehen und Ablegen oder aus einem eingebetteten OLE-Element verwendet.

Container können diese Funktion verwenden, um die Befehle "Einfügen bearbeiten" und "Inhalte bearbeiten" zu aktivieren oder zu deaktivieren.

Weitere Informationen finden Sie im Artikel "Data Objects and Data Sources (OLE)".

COleClientItem::CanCreateLinkFromData

Überprüft, ob eine Containeranwendung ein verknüpftes Objekt aus dem angegebenen COleDataObject Objekt erstellen kann.

static BOOL PASCAL CanCreateLinkFromData(const COleDataObject* pDataObject);

Parameter

pDataObject
Zeiger auf das COleDataObject-Objekt , aus dem das OLE-Element erstellt werden soll.

Rückgabewert

Nonzero, wenn der Container ein verknüpftes Objekt aus dem COleDataObject Objekt erstellen kann.

Hinweise

Container können diese Funktion verwenden, um die Befehle "Inhalte einfügen" und "Link bearbeiten" zu aktivieren oder zu deaktivieren.

Weitere Informationen finden Sie im Artikel "Data Objects and Data Sources (OLE)".

COleClientItem::CanPaste

Rufen Sie diese Funktion auf, um festzustellen, ob ein eingebettetes OLE-Element aus der Zwischenablage eingefügt werden kann.

static BOOL PASCAL CanPaste();

Rückgabewert

Nonzero, wenn ein eingebettetes OLE-Element aus der Zwischenablage eingefügt werden kann; andernfalls 0.

Hinweise

Weitere Informationen finden Sie unter OleGetClipboard und OleQueryCreateFromData im Windows SDK.

COleClientItem::CanPasteLink

Rufen Sie diese Funktion auf, um festzustellen, ob ein verknüpftes OLE-Element aus der Zwischenablage eingefügt werden kann.

static BOOL PASCAL CanPasteLink();

Rückgabewert

Nonzero, wenn ein verknüpftes OLE-Element aus der Zwischenablage eingefügt werden kann; andernfalls 0.

Hinweise

Weitere Informationen finden Sie unter OleGetClipboard und OleQueryLinkFromData im Windows SDK.

COleClientItem::Close

Rufen Sie diese Funktion auf, um den Zustand eines OLE-Elements vom ausgeführten Zustand in den geladenen Zustand zu ändern, d. h., geladen mit seinem Handler im Arbeitsspeicher, aber mit dem Server nicht ausgeführt wird.

void Close(OLECLOSE dwCloseOption = OLECLOSE_SAVEIFDIRTY);

Parameter

dwCloseOption
Flag, das angibt, unter welchen Umständen das OLE-Element gespeichert wird, wenn es in den geladenen Zustand zurückkehrt. Sie kann einen der folgenden Werte aufweisen:

OLECLOSE_SAVEIFDIRTY Das OLE-Element speichern.
OLECLOSE_NOSAVE Das OLE-Element nicht speichern.
OLECLOSE_PROMPTSAVE Den Benutzer auffordern, ob das OLE-Element gespeichert werden soll.

Hinweise

Diese Funktion hat keine Auswirkung, wenn das OLE-Element nicht ausgeführt wird.

Weitere Informationen finden Sie unter "IOleObject::Close " im Windows SDK.

COleClientItem::COleClientItem

Erstellt ein COleClientItem Objekt und fügt es der Auflistung des Containerdokuments von Dokumentelementen hinzu, die nur das C++-Objekt erstellt und keine OLE-Initialisierung ausführt.

COleClientItem(COleDocument* pContainerDoc = NULL);

Parameter

pContainerDoc
Zeigen Sie auf das Containerdokument, das dieses Element enthält. Dies kann eine beliebige COleDocument-Ableitung sein.

Hinweise

Wenn Sie einen NULL-Zeiger übergeben, wird dem Containerdokument keine Ergänzung vorgenommen. Sie müssen COleDocument::AddItem explizit aufrufen.

Sie müssen eine der folgenden Elementfunktionen zum Erstellen aufrufen, bevor Sie das OLE-Element verwenden:

CreateFromClipboard
CreateFromData
CreateFromFile
CreateStaticFromClipboard
CreateStaticFromData
CreateLinkFromClipboard
CreateLinkFromData
CreateLinkFromFile
CreateNewItem
CreateCloneFrom

COleClientItem::ConvertTo

Rufen Sie diese Memberfunktion auf, um das Element in den durch clsidNew angegebenen Typ zu konvertieren.

virtual BOOL ConvertTo(REFCLSID clsidNew);

Parameter

clsidNew
Die Klassen-ID des Zieltyps.

Rückgabewert

Ungleich Null, wenn erfolgreich, andernfalls 0 (Null).

Hinweise

Dies wird automatisch von COleConvertDialog aufgerufen. Es ist nicht erforderlich, sie direkt aufzurufen.

COleClientItem::CopyToClipboard

Rufen Sie diese Funktion auf, um das OLE-Element in die Zwischenablage zu kopieren.

void CopyToClipboard(BOOL bIncludeLink = FALSE);

Parameter

bIncludeLink
TRUE, wenn Verknüpfungsinformationen in die Zwischenablage kopiert werden sollen, sodass ein verknüpftes Element eingefügt werden kann; andernfalls FALSE.

Hinweise

In der Regel rufen Sie diese Funktion beim Schreiben von Nachrichtenhandlern für die Befehle "Kopieren" oder "Ausschneiden" im Menü "Bearbeiten" auf. Sie müssen die Elementauswahl in Ihrer Containeranwendung implementieren, wenn Sie die Befehle "Kopieren" oder "Ausschneiden" implementieren möchten.

Weitere Informationen finden Sie unter OleSetClipboard im Windows SDK.

COleClientItem::CreateCloneFrom

Rufen Sie diese Funktion auf, um eine Kopie des angegebenen OLE-Elements zu erstellen.

BOOL CreateCloneFrom(const COleClientItem* pSrcItem);

Parameter

pSrcItem
Zeiger auf das OLE-Element, das dupliziert werden soll.

Rückgabewert

Ungleich Null, wenn erfolgreich, andernfalls 0 (Null).

Hinweise

Die Kopie ist identisch mit dem Quellelement. Sie können diese Funktion verwenden, um Rückgängig-Vorgänge zu unterstützen.

COleClientItem::CreateFromClipboard

Rufen Sie diese Funktion auf, um ein eingebettetes Element aus dem Inhalt der Zwischenablage zu erstellen.

BOOL CreateFromClipboard(
    OLERENDER render = OLERENDER_DRAW,
    CLIPFORMAT cfFormat = 0,
    LPFORMATETC lpFormatEtc = NULL);

Parameter

render
Flag, das angibt, wie der Server das OLE-Element rendert. Mögliche Werte finden Sie unter OLERENDER im Windows SDK.

cfFormat
Gibt das Zwischenablagedatenformat an, das beim Erstellen des OLE-Elements zwischengespeichert werden soll.

lpFormatEtc
Zeiger auf eine FORMATTC-Struktur , die verwendet wird, wenn das Rendern OLERENDER_FORMAT oder OLERENDER_DRAW ist. Geben Sie einen Wert für diesen Parameter nur an, wenn Sie zusätzliche Formatinformationen über das durch cfFormat angegebene Zwischenablageformat angeben möchten. Wenn Sie diesen Parameter weglassen, werden Standardwerte für die anderen Felder in der FORMATETC Struktur verwendet.

Rückgabewert

Ungleich Null, wenn erfolgreich, andernfalls 0 (Null).

Hinweise

Normalerweise rufen Sie diese Funktion aus dem Meldungshandler für den Befehl "Einfügen" im Menü "Bearbeiten" auf. (Der Befehl "Einfügen" ist vom Framework aktiviert, wenn CanPaste-Memberfunktion gibt nonzero zurück.)

Weitere Informationen finden Sie unter OLERENDER und FORMATETC im Windows SDK.

COleClientItem::CreateFromData

Rufen Sie diese Funktion auf, um ein eingebettetes Element aus einem COleDataObject Objekt zu erstellen.

BOOL CreateFromData(
    COleDataObject* pDataObject,
    OLERENDER render = OLERENDER_DRAW,
    CLIPFORMAT cfFormat = 0,
    LPFORMATETC lpFormatEtc = NULL);

Parameter

pDataObject
Zeiger auf das COleDataObject-Objekt , aus dem das OLE-Element erstellt werden soll.

render
Flag, das angibt, wie der Server das OLE-Element rendert. Mögliche Werte finden Sie unter OLERENDER im Windows SDK.

cfFormat
Gibt das Zwischenablagedatenformat an, das beim Erstellen des OLE-Elements zwischengespeichert werden soll.

Rückgabewert

Ungleich Null, wenn erfolgreich, andernfalls 0 (Null).

Hinweise

Datenübertragungsvorgänge, z. B. Einfügen aus der Zwischenablage oder Drag-and-Drop-Vorgänge, stellen Objekte bereit COleDataObject , die die von einer Serveranwendung angebotenen Informationen enthalten. Sie wird in der Regel in Ihrer Außerkraftsetzung von CView::OnDrop verwendet.

Weitere Informationen finden Sie unter OleCreateFromData, OLERENDER und FORMATETC im Windows SDK.

COleClientItem::CreateFromFile

Rufen Sie diese Funktion auf, um ein eingebettetes OLE-Element aus einer Datei zu erstellen.

BOOL CreateFromFile(
    LPCTSTR lpszFileName,
    REFCLSID clsid = CLSID_NULL,
    OLERENDER render = OLERENDER_DRAW,
    CLIPFORMAT cfFormat = 0,
    LPFORMATETC lpFormatEtc = NULL);

Parameter

lpszFileName
Zeigen Sie auf den Namen der Datei, aus der das OLE-Element erstellt werden soll.

clsid
Für die zukünftige Verwendung reserviert.

render
Flag, das angibt, wie der Server das OLE-Element rendert. Mögliche Werte finden Sie unter OLERENDER im Windows SDK.

cfFormat
Gibt das Zwischenablagedatenformat an, das beim Erstellen des OLE-Elements zwischengespeichert werden soll.

Rückgabewert

Ungleich Null, wenn erfolgreich, andernfalls 0 (Null).

Hinweise

Das Framework ruft diese Funktion aus COleInsertDialog::CreateItem auf, wenn der Benutzer im Dialogfeld "Objekt einfügen" ok auswählt, wenn die Schaltfläche "Aus Datei erstellen" ausgewählt ist.

Weitere Informationen finden Sie unter OleCreateFromFile, OLERENDER und FORMATETC im Windows SDK.

COleClientItem::CreateLinkFromClipboard

Rufen Sie diese Funktion auf, um ein verknüpftes Element aus dem Inhalt der Zwischenablage zu erstellen.

BOOL CreateLinkFromClipboard(
    OLERENDER render = OLERENDER_DRAW,
    CLIPFORMAT cfFormat = 0,
    LPFORMATETC lpFormatEtc = NULL);

Parameter

render
Flag, das angibt, wie der Server das OLE-Element rendert. Mögliche Werte finden Sie unter OLERENDER im Windows SDK.

cfFormat
Gibt das Zwischenablagedatenformat an, das beim Erstellen des OLE-Elements zwischengespeichert werden soll.

Rückgabewert

Ungleich Null, wenn erfolgreich, andernfalls 0 (Null).

Hinweise

Normalerweise rufen Sie diese Funktion aus dem Meldungshandler für den Befehl "Link einfügen" im Menü "Bearbeiten" auf. (Der Befehl "Link einfügen" ist in der Standardimplementierung von COleDocument , wenn die Zwischenablage ein OLE-Element enthält, mit dem verknüpft werden kann.)

Weitere Informationen finden Sie unter OLERENDER und FORMATETC im Windows SDK.

COleClientItem::CreateLinkFromData

Rufen Sie diese Funktion auf, um ein verknüpftes Element aus einem COleDataObject Objekt zu erstellen.

BOOL CreateLinkFromData(
    COleDataObject* pDataObject,
    OLERENDER render = OLERENDER_DRAW,
    CLIPFORMAT cfFormat = 0,
    LPFORMATETC lpFormatEtc = NULL);

Parameter

pDataObject
Zeiger auf das COleDataObject-Objekt , aus dem das OLE-Element erstellt werden soll.

render
Flag, das angibt, wie der Server das OLE-Element rendert. Mögliche Werte finden Sie unter OLERENDER im Windows SDK.

cfFormat
Gibt das Zwischenablagedatenformat an, das beim Erstellen des OLE-Elements zwischengespeichert werden soll.

Rückgabewert

Ungleich Null, wenn erfolgreich, andernfalls 0 (Null).

Hinweise

Rufen Sie dies während eines Ablagevorgangs auf, wenn der Benutzer angibt, dass ein Link erstellt werden soll. Sie kann auch zum Behandeln des Befehls "Einfügen bearbeiten" verwendet werden. Sie wird vom Framework in COleClientItem::CreateLinkFromClipboard und in COlePasteSpecialDialog::CreateItem aufgerufen, wenn die Option "Link" ausgewählt wurde.

Weitere Informationen finden Sie unter OleCreateLinkFromData, OLERENDER und FORMATETC im Windows SDK.

COleClientItem::CreateLinkFromFile

Rufen Sie diese Funktion auf, um ein verknüpftes OLE-Element aus einer Datei zu erstellen.

BOOL CreateLinkFromFile(
    LPCTSTR lpszFileName,
    OLERENDER render = OLERENDER_DRAW,
    CLIPFORMAT cfFormat = 0,
    LPFORMATETC lpFormatEtc = NULL);

Parameter

lpszFileName
Zeigen Sie auf den Namen der Datei, aus der das OLE-Element erstellt werden soll.

render
Flag, das angibt, wie der Server das OLE-Element rendert. Mögliche Werte finden Sie unter OLERENDER im Windows SDK.

cfFormat
Gibt das Zwischenablagedatenformat an, das beim Erstellen des OLE-Elements zwischengespeichert werden soll.

Rückgabewert

Ungleich Null, wenn erfolgreich, andernfalls 0 (Null).

Hinweise

Das Framework ruft diese Funktion auf, wenn der Benutzer im Dialogfeld "Objekt einfügen" "OK" auswählt, wenn die Schaltfläche "Aus Datei erstellen" aktiviert ist und das Kontrollkästchen "Verknüpfen" aktiviert ist. Sie wird von COleInsertDialog::CreateItem aufgerufen.

Weitere Informationen finden Sie unter OleCreateLinkToFile, OLERENDER und FORMATETC im Windows SDK.

COleClientItem::CreateNewItem

Rufen Sie diese Funktion auf, um ein eingebettetes Element zu erstellen; diese Funktion startet die Serveranwendung, mit der der Benutzer das OLE-Element erstellen kann.

BOOL CreateNewItem(
    REFCLSID clsid,
    OLERENDER render = OLERENDER_DRAW,
    CLIPFORMAT cfFormat = 0,
    LPFORMATETC lpFormatEtc = NULL);

Parameter

clsid
ID, die den typ des zu erstellenden OLE-Elements eindeutig identifiziert.

render
Flag, das angibt, wie der Server das OLE-Element rendert. Mögliche Werte finden Sie unter OLERENDER im Windows SDK.

cfFormat
Gibt das Zwischenablagedatenformat an, das beim Erstellen des OLE-Elements zwischengespeichert werden soll.

Rückgabewert

Ungleich Null, wenn erfolgreich, andernfalls 0 (Null).

Hinweise

Das Framework ruft diese Funktion auf, wenn der Benutzer im Dialogfeld "Objekt einfügen" "OK" auswählt, wenn die Schaltfläche "Neu erstellen" ausgewählt ist.

Weitere Informationen finden Sie unter OleCreate, OLERENDER und FORMATETC im Windows SDK.

COleClientItem::CreateStaticFromClipboard

Rufen Sie diese Funktion auf, um ein statisches Element aus dem Inhalt der Zwischenablage zu erstellen.

BOOL CreateStaticFromClipboard(
    OLERENDER render = OLERENDER_DRAW,
    CLIPFORMAT cfFormat = 0,
    LPFORMATETC lpFormatEtc = NULL);

Parameter

render
Flag, das angibt, wie der Server das OLE-Element rendert. Mögliche Werte finden Sie unter OLERENDER im Windows SDK.

cfFormat
Gibt das Zwischenablagedatenformat an, das beim Erstellen des OLE-Elements zwischengespeichert werden soll.

Rückgabewert

Ungleich Null, wenn erfolgreich, andernfalls 0 (Null).

Hinweise

Ein statisches Element enthält die Präsentationsdaten, aber nicht die nativen Daten; folglich kann sie nicht bearbeitet werden. Normalerweise rufen Sie diese Funktion auf, wenn die CreateFromClipboard-Memberfunktion fehlschlägt.

Weitere Informationen finden Sie unter OLERENDER und FORMATETC im Windows SDK.

COleClientItem::CreateStaticFromData

Rufen Sie diese Funktion auf, um ein statisches Element aus einem COleDataObject Objekt zu erstellen.

BOOL CreateStaticFromData(
    COleDataObject* pDataObject,
    OLERENDER render = OLERENDER_DRAW,
    CLIPFORMAT cfFormat = 0,
    LPFORMATETC lpFormatEtc = NULL);

Parameter

pDataObject
Zeiger auf das COleDataObject-Objekt , aus dem das OLE-Element erstellt werden soll.

render
Flag, das angibt, wie der Server das OLE-Element rendert. Mögliche Werte finden Sie unter OLERENDER im Windows SDK.

cfFormat
Gibt das Zwischenablagedatenformat an, das beim Erstellen des OLE-Elements zwischengespeichert werden soll.

Rückgabewert

Ungleich Null, wenn erfolgreich, andernfalls 0 (Null).

Hinweise

Ein statisches Element enthält die Präsentationsdaten, aber nicht die nativen Daten; folglich kann sie nicht bearbeitet werden. Dies ist im Wesentlichen identisch mit CreateStaticFromClipboard , mit der Ausnahme, dass ein statisches Element aus einer beliebigen COleDataObject, nicht nur aus der Zwischenablage erstellt werden kann.

Wird in COlePasteSpecialDialog::CreateItem verwendet, wenn "Static" ausgewählt ist.

Weitere Informationen finden Sie unter OleCreateStaticFromData, OLERENDER und FORMATETC im Windows SDK.

COleClientItem::D eaktivieren

Rufen Sie diese Funktion auf, um das OLE-Element zu deaktivieren und alle zugehörigen Ressourcen freizugeben.

void Deactivate();

Hinweise

In der Regel deaktivieren Sie ein aktives OLE-Element, wenn der Benutzer auf den Clientbereich außerhalb der Grenzen des Elements klickt. Beachten Sie, dass die Deaktivierung des OLE-Elements den Rückgängig-Zustand verwirft, wodurch es unmöglich ist, die ReactivateAndUndo-Memberfunktion aufzurufen.

Wenn Ihre Anwendung "Rückgängig" unterstützt, rufen Sie nicht auf Deactivate; rufen Sie stattdessen DeactivateUI auf.

Weitere Informationen finden Sie unter "IOleInPlaceObject::InPlaceDeactivate " im Windows SDK.

COleClientItem::D eactivateUI

Rufen Sie diese Funktion auf, wenn der Benutzer ein Element deaktiviert, das aktiviert wurde.

void DeactivateUI();

Hinweise

Diese Funktion stellt die Benutzeroberfläche der Containeranwendung in den ursprünglichen Zustand wieder her, wobei alle Menüs und andere Steuerelemente ausgeblendet werden, die für die direkte Aktivierung erstellt wurden.

Mit dieser Funktion werden die Statusinformationen für das Element nicht geleert. Diese Informationen werden beibehalten, damit ReactivateAndUndo später verwendet werden kann, um einen Rückgängig-Befehl in der Serveranwendung auszuführen, falls der Rückgängig-Befehl des Containers unmittelbar nach der Deaktivierung des Elements ausgewählt wird.

Weitere Informationen finden Sie unter "IOleInPlaceObject::InPlaceDeactivate " im Windows SDK.

COleClientItem::D elete

Rufen Sie diese Funktion auf, um das OLE-Element aus dem Containerdokument zu löschen.

void Delete(BOOL bAutoDelete = TRUE);

Parameter

bAutoDelete
Gibt an, ob das Element aus dem Dokument entfernt werden soll.

Hinweise

Diese Funktion ruft die Release-Memberfunktion auf, die wiederum das C++-Objekt für das Element löscht und das OLE-Element dauerhaft aus dem Dokument entfernt. Wenn das OLE-Element eingebettet ist, werden die systemeigenen Daten für das Element gelöscht. Er schließt immer einen ausgeführten Server. Wenn es sich bei dem Element um einen geöffneten Link handelt, wird es von dieser Funktion geschlossen.

COleClientItem::D oDragDrop

Rufen Sie die DoDragDrop Memberfunktion auf, um einen Drag-and-Drop-Vorgang auszuführen.

DROPEFFECT DoDragDrop(
    LPCRECT lpItemRect,
    CPoint ptOffset,
    BOOL bIncludeLink = FALSE,
    DWORD dwEffects = DROPEFFECT_COPY | DROPEFFECT_MOVE,
    LPCRECT lpRectStartDrag = NULL);

Parameter

lpItemRect
Das Rechteck des Elements auf dem Bildschirm in Clientkoordinaten (Pixel)

ptOffset
Der Offset von lpItemRect , bei dem sich die Mausposition zum Zeitpunkt des Ziehens befand.

bIncludeLink
Legen Sie diesen Wert auf TRUE fest, wenn die Verknüpfungsdaten in die Zwischenablage kopiert werden sollen. Legen Sie ihn auf FALSE fest, wenn die Serveranwendung keine Links unterstützt.

dwEffects
Bestimmt die Effekte, die die Ziehquelle im Ziehvorgang zulässt.

lpRectStartDrag
Zeiger auf das Rechteck, das definiert, wo der Ziehvorgang tatsächlich beginnt. Weitere Informationen finden Sie im folgenden Abschnitt "Hinweise".

Rückgabewert

Ein DROPEFFECT-Wert. Wenn es DROPEFFECT_MOVE ist, sollten die ursprünglichen Daten entfernt werden.

Hinweise

Der Drag-and-Drop-Vorgang wird nicht sofort gestartet. Es wartet, bis der Mauscursor das durch lpRectStartDrag angegebene Rechteck verlässt oder bis eine angegebene Anzahl von Millisekunden übergeben wurde. Wenn lpRectStartDrag NULL ist, ist die Größe des Rechtecks ein Pixel.

Die Verzögerungszeit wird durch eine Registrierungsschlüsseleinstellung angegeben. Sie können die Verzögerungszeit ändern, indem Sie CWinApp::WriteProfileString oder CWinApp::WriteProfileInt aufrufen. Wenn Sie die Verzögerungszeit nicht angeben, wird ein Standardwert von 200 Millisekunden verwendet. Die Verzögerungszeit des Ziehens wird wie folgt gespeichert:

Die Verzögerungszeit des Windows NT-Ziehens wird in HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\NT\CurrentVersion\IniFileMapping\win.ini\Windows\DragDelay gespeichert.
Die Verzögerungszeit von Windows 3.x wird im WIN gespeichert. INI-Datei unter dem Abschnitt [Windows}
Windows 95/98 Ziehverzögerungszeit wird in einer zwischengespeicherten Version von WIN gespeichert. INI.

Weitere Informationen dazu, wie Ziehverzögerungsinformationen entweder in der Registrierung oder in der Registrierung gespeichert werden. INI-Datei finden Sie unter WriteProfileString im Windows SDK.

COleClientItem::D oVerb

Aufrufen DoVerb , um das angegebene Verb auszuführen.

virtual BOOL DoVerb(
    LONG nVerb,
    CView* pView,
    LPMSG lpMsg = NULL);

Parameter

nVerb
Gibt das auszuführende Verb an. Sie kann eine der folgenden Elemente enthalten:

Wert	Bedeutung	Symbol
- 0	Primäres Verb	OLEIVERB_PRIMARY
- 1	Sekundäres Verb	(Keine)
- 1	Element zum Bearbeiten anzeigen	OLEIVERB_SHOW
- 2	Element in separatem Fenster bearbeiten	OLEIVERB_OPEN
- 3	Element ausblenden	OLEIVERB_HIDE

pView
Zeiger auf das Ansichtsfenster; dies wird vom Server für die direkte Aktivierung verwendet. Dieser Parameter sollte NULL sein, wenn die Containeranwendung keine direkte Aktivierung zulässt.

lpMsg
Zeigen Sie auf die Nachricht, die dazu führte, dass das Element aktiviert wurde.

Rückgabewert

Nonzero, wenn das Verb erfolgreich ausgeführt wurde; andernfalls 0.

Hinweise

Diese Funktion ruft die Funktion "Member aktivieren" auf, um das Verb auszuführen. Außerdem werden Ausnahmen erfasst und dem Benutzer ein Meldungsfeld angezeigt, wenn eins ausgelöst wird.

COleClientItem::D raw

Rufen Sie diese Funktion auf, um das OLE-Element mithilfe des angegebenen Gerätekontexts in das angegebene umgebende Rechteck zu zeichnen.

BOOL Draw(
    CDC* pDC,
    LPCRECT lpBounds,
    DVASPECT nDrawAspect = (DVASPECT)-1);

Parameter

pDC
Zeiger auf ein CDC-Objekt , das zum Zeichnen des OLE-Elements verwendet wird.

lpBounds
Zeiger auf ein CRect-Objekt oder RECT eine Struktur, das das umgebende Rechteck definiert, in dem das OLE-Element gezeichnet werden soll (in logischen Einheiten, die vom Gerätekontext bestimmt werden).

nDrawAspect
Gibt den Aspekt des OLE-Elements an, d. h. wie es angezeigt werden soll. Wenn nDrawAspect -1 ist, wird der letzte Aspekt verwendet, der mithilfe von SetDrawAspect festgelegt wird. Weitere Informationen zu möglichen Werten für dieses Flag finden Sie unter SetDrawAspect.

Rückgabewert

Ungleich Null, wenn erfolgreich, andernfalls 0 (Null).

Hinweise

Die Funktion kann die Metadateidarstellung des OLE-Elements verwenden, das von der OnDraw-Memberfunktion COleServerItemerstellt wurde.

In der Regel verwenden Draw Sie die Bildschirmanzeige und übergeben den Bildschirmgerätekontext als pDC. In diesem Fall müssen Sie nur die ersten beiden Parameter angeben.

Der lpBounds-Parameter identifiziert das Rechteck im Zielgerätekontext (relativ zum aktuellen Zuordnungsmodus ). Das Rendern kann die Skalierung des Bilds umfassen und von Containeranwendungen verwendet werden, um eine Ansicht zu erzwingen, die zwischen der angezeigten Ansicht und dem endgültigen gedruckten Bild skaliert wird.

Weitere Informationen finden Sie unter "IViewObject::D raw " im Windows SDK.

COleClientItem::GetActiveView

Gibt die Ansicht zurück, in der das Element aktiviert ist.

CView* GetActiveView() const;

Rückgabewert

Ein Zeiger auf die Ansicht; andernfalls NULL, wenn das Element nicht aktiviert ist.

COleClientItem::GetCachedExtent

Rufen Sie diese Funktion auf, um die Größe des OLE-Elements abzurufen.

BOOL GetCachedExtent(
    LPSIZE lpSize,
    DVASPECT nDrawAspect = (DVASPECT)-1);

Parameter

lpSize
Zeigen Sie auf eine SIZE Struktur oder ein CSize-Objekt , das die Größeninformationen empfängt.

nDrawAspect
Gibt den Aspekt des OLE-Elements an, dessen Grenzen abgerufen werden sollen. Mögliche Werte finden Sie unter SetDrawAspect.

Rückgabewert

Nonzero bei erfolgreicher Ausführung; 0, wenn das OLE-Element leer ist.

Hinweise

Diese Funktion stellt die gleichen Informationen wie GetExtent bereit. Sie können jedoch aufrufen GetCachedExtent , um Umfangsinformationen während der Verarbeitung anderer OLE-Handler abzurufen, z . B. OnChange. Die Abmessungen befinden sich in MM_HIMETRIC Einheiten.

Dies ist möglich, da GetCachedExtent die IViewObject2-Schnittstelle anstelle der IOleObject-Schnittstelle verwendet wird, um den Umfang dieses Elements abzurufen. Das IViewObject2 COM-Objekt speichert die Umfangsinformationen zwischen, die im vorherigen Aufruf von IViewObject::D raw verwendet werden.

Weitere Informationen finden Sie unter "IViewObject2::GetExtent " im Windows SDK.

COleClientItem::GetClassID

Gibt die Klassen-ID des Elements in den Speicher zurück, auf den pClassID verweist.

void GetClassID(CLSID* pClassID) const;

Parameter

pClassID
Zeigen Sie auf einen Bezeichner vom Typ CLSID , um die Klassen-ID abzurufen. Informationen zu CLSID finden Sie im Windows SDK.

Hinweise

Die Klassen-ID ist eine 128-Bit-Nummer, die die Anwendung eindeutig identifiziert, die das Element bearbeitet.

Weitere Informationen finden Sie unter "IPersist::GetClassID " im Windows SDK.

COleClientItem::GetClipboardData

Rufen Sie diese Funktion auf, um ein COleDataSource Objekt abzurufen, das alle Daten enthält, die durch einen Aufruf der CopyToClipboard-Memberfunktion in der Zwischenablage platziert werden.

void GetClipboardData(
    COleDataSource* pDataSource,
    BOOL bIncludeLink = FALSE,
    LPPOINT lpOffset = NULL,
    LPSIZE lpSize = NULL);

Parameter

pDataSource
Zeiger auf ein COleDataSource-Objekt , das die im OLE-Element enthaltenen Daten empfängt.

bIncludeLink
TRUE, wenn Verknüpfungsdaten einbezogen werden sollen; andernfalls FALSE.

lpOffset
Der Offset des Mauscursors vom Ursprung des Objekts in Pixeln.

lpSize
Die Größe des Objekts in Pixel.

Hinweise

GetClipboardData wird als Standardimplementierung von OnGetClipboardData aufgerufen. Überschreiben OnGetClipboardData Sie nur, wenn Sie zusätzlich zu den von CopyToClipboardIhnen angebotenen Datenformaten Datenformate anbieten möchten. Platzieren Sie diese Formate vor oder nach dem Aufrufen im COleDataSource Objekt, und übergeben Sie das COleDataSource Objekt dann an die COleDataSource::SetClipboard-Funktion.CopyToClipboard Wenn Sie z. B. die Position des OLE-Elements in seinem Containerdokument in der Zwischenablage begleiten möchten, definieren Sie ihr eigenes Format zum Übergeben dieser Informationen und platzieren sie vor dem COleDataSource Aufrufen CopyToClipboard.

COleClientItem::GetDocument

Rufen Sie diese Funktion auf, um einen Zeiger auf das Dokument abzurufen, das das OLE-Element enthält.

COleDocument* GetDocument() const;

Rückgabewert

Ein Zeiger auf das Dokument, das das OLE-Element enthält. NULL, wenn das Element nicht Teil eines Dokuments ist.

Hinweise

Dieser Zeiger ermöglicht den Zugriff auf das COleDocument Objekt, das Sie als Argument an den COleClientItem Konstruktor übergeben haben.

COleClientItem::GetDrawAspect

Rufen Sie die GetDrawAspect Memberfunktion auf, um den aktuellen "Aspekt" oder die aktuelle Ansicht des Elements zu ermitteln.

DVASPECT GetDrawAspect() const;

Rückgabewert

Ein Wert aus der DVASPECT-Aufzählung, deren Werte in der Referenz für SetDrawAspect aufgeführt sind.

Hinweise

Der Aspekt gibt an, wie das Element gerendert werden soll.

COleClientItem::GetExtent

Rufen Sie diese Funktion auf, um die Größe des OLE-Elements abzurufen.

BOOL GetExtent(
    LPSIZE lpSize,
    DVASPECT nDrawAspect = (DVASPECT)- 1);

Parameter

lpSize
Zeiger auf eine SIZE Struktur oder ein CSize Objekt, das die Größeninformationen empfängt.

nDrawAspect
Gibt den Aspekt des OLE-Elements an, dessen Grenzen abgerufen werden sollen. Mögliche Werte finden Sie unter SetDrawAspect.

Rückgabewert

Nonzero bei erfolgreicher Ausführung; 0, wenn das OLE-Element leer ist.

Hinweise

Wenn die Serveranwendung mit der Microsoft Foundation Class Library geschrieben wurde, bewirkt diese Funktion, dass die OnGetExtent-Memberfunktion des entsprechenden COleServerItem Objekts aufgerufen wird. Beachten Sie, dass sich die abgerufene Größe von der zuletzt von der SetExtent-Memberfunktion festgelegten Größe unterscheiden kann. Die angegebene SetExtent Größe wird als Vorschlag behandelt. Die Abmessungen befinden sich in MM_HIMETRIC Einheiten.

Hinweis

Rufen Sie während der Verarbeitung eines OLE-Handlers, z. B. OnChange, nicht aufGetExtent. Rufen Sie stattdessen GetCachedExtent auf.

Weitere Informationen finden Sie unter "IOleObject::GetExtent " im Windows SDK.

COleClientItem::GetIconFromRegistry

Rufen Sie diese Memberfunktion auf, um ein Handle zu einer Symbolressource abzurufen, die dem Server einer bestimmten CLSID zugeordnet ist.

HICON GetIconFromRegistry() const;

static HICON GetIconFromRegistry(CLSID& clsid);

Parameter

clsid
Ein Verweis auf die CLSID für den Server, der dem Symbol zugeordnet ist.

Rückgabewert

Ein gültiges Handle für die Symbolressource oder NULL, wenn das Symbol des Servers oder ein Standardsymbol nicht gefunden werden kann.

Hinweise

Diese Memberfunktion startet den Server nicht oder ruft ein Symbol dynamisch ab, auch wenn der Server bereits ausgeführt wird. Stattdessen öffnet diese Memberfunktion das ausführbare Image des Servers und ruft das statische Symbol ab, das dem Server zugeordnet ist, während es registriert wurde.

COleClientItem::GetIconicMetafile

Ruft die Metadatei ab, die zum Zeichnen des Elements-Symbols verwendet wird.

HGLOBAL GetIconicMetafile();

Rückgabewert

Ein Handle für die Metadatei bei erfolgreicher Ausführung; andernfalls NULL.

Hinweise

Wenn kein aktuelles Symbol vorhanden ist, wird ein Standardsymbol zurückgegeben. Dies wird automatisch von den MFC/OLE-Dialogfeldern aufgerufen und wird in der Regel nicht direkt aufgerufen.

Diese Funktion ruft auch SetIconicMetafile auf, um die Metadatei für die spätere Verwendung zwischenzuspeichern.

COleClientItem::GetInPlaceWindow

Rufen Sie die GetInPlaceWindow Memberfunktion auf, um einen Zeiger auf das Fenster abzurufen, in dem das Element zur direkten Bearbeitung geöffnet wurde.

CWnd* GetInPlaceWindow();

Rückgabewert

Ein Zeiger auf das direkte Bearbeitungsfenster des Elements; NULL, wenn das Element nicht aktiv ist oder der Server nicht verfügbar ist.

Hinweise

Diese Funktion sollte nur für Elemente aufgerufen werden, die aktiv sind.

COleClientItem::GetItemState

Rufen Sie diese Funktion auf, um den aktuellen Zustand des OLE-Elements abzurufen.

UINT GetItemState() const;

Rückgabewert

Ein COleClientItem::ItemState aufgezählter Wert, der eine der folgenden Sein kann: emptyState, , loadedState, openState, , activeState. activeUIState Informationen zu diesen Zuständen finden Sie im Artikel "Container: Client-Item States".

Hinweise

Um benachrichtigt zu werden, wenn sich der Zustand des OLE-Elements ändert, verwenden Sie die OnChange-Memberfunktion .

Weitere Informationen finden Sie im Artikel "Container: Client-Item States".

COleClientItem::GetLastStatus

Gibt den Statuscode des letzten OLE-Vorgangs zurück.

SCODE GetLastStatus() const;

Rückgabewert

Ein SCODE-Wert.

Hinweise

Für Memberfunktionen, die einen BOOL-Wert von FALSE oder andere Memberfunktionen zurückgeben, die NULL zurückgeben, GetLastStatus werden detailliertere Fehlerinformationen zurückgegeben. Beachten Sie, dass die meisten OLE-Memberfunktionen Ausnahmen für schwerwiegendere Fehler auslösen. Die spezifischen Informationen zur Interpretation des SCODE hängen vom zugrunde liegenden OLE-Aufruf ab, der zuletzt einen SCODE-Wert zurückgegeben hat.

Weitere Informationen zu SCODE finden Sie in der Windows SDK-Dokumentation unter Struktur der COM-Fehlercodes .

COleClientItem::GetLinkUpdateOptions

Rufen Sie diese Funktion auf, um den aktuellen Wert der Linkaktualisierungsoption für das OLE-Element abzurufen.

OLEUPDATE GetLinkUpdateOptions();

Rückgabewert

Einer der folgenden Werte:

OLEUPDATE_ALWAYS Aktualisieren des verknüpften Elements nach Möglichkeit. Diese Option unterstützt das Optionsfeld "Automatische Verknüpfungsaktualisierung" im Dialogfeld "Links".
OLEUPDATE_ONCALL Aktualisieren sie das verknüpfte Element nur auf Anforderung aus der Containeranwendung (wenn die UpdateLink-Memberfunktion aufgerufen wird). Diese Option unterstützt das Optionsfeld "Manuelle Verknüpfungsaktualisierung" im Dialogfeld "Links".

Hinweise

Dies ist ein erweiterter Vorgang.

Diese Funktion wird automatisch von der COleLinksDialog-Klasse aufgerufen.

Weitere Informationen finden Sie unter "IOleLink::GetUpdateOptions" im Windows SDK.

COleClientItem::GetType

Rufen Sie diese Funktion auf, um zu bestimmen, ob das OLE-Element eingebettet oder verknüpft oder statisch ist.

OLE_OBJTYPE GetType() const;

Rückgabewert

Eine nicht signierte ganze Zahl mit einem der folgenden Werte:

OT_LINK Das OLE-Element ist ein Link.
OT_EMBEDDED Das OLE-Element ist eingebettet.
OT_STATIC Das OLE-Element ist statisch, d. h., es enthält nur Präsentationsdaten, keine nativen Daten und kann daher nicht bearbeitet werden.

COleClientItem::GetUserType

Rufen Sie diese Funktion auf, um die vom Benutzer sichtbare Zeichenfolge abzurufen, die den Typ des OLE-Elements beschreibt, z. B. "Word-Dokument".

void GetUserType(
    USERCLASSTYPE nUserClassType,
    CString& rString);

Parameter

nUserClassType
Ein Wert, der die gewünschte Variante der Zeichenfolge angibt, die den Typ des OLE-Elements beschreibt. Dies kann einen der folgenden Werte haben:

USERCLASSTYPE_FULL Der vollständige Typname, der dem Benutzer angezeigt wird.
USERCLASSTYPE_SHORT Ein kurzer Name (maximal 15 Zeichen) für die Verwendung in Popupmenüs und im Dialogfeld "Verknüpfungen bearbeiten".
USERCLASSTYPE_APPNAME Name der Anwendung, die die Klasse gewartet.

rString
Ein Verweis auf ein CString -Objekt, an das die Zeichenfolge, die den Typ des OLE-Elements beschreibt, zurückgegeben werden soll.

Hinweise

Dies ist häufig der Eintrag in der Systemregistrierungsdatenbank.

Wenn der vollständige Typname angefordert, aber nicht verfügbar ist, wird stattdessen der Kurzname verwendet. Wenn kein Eintrag für den Typ des OLE-Elements in der Registrierungsdatenbank gefunden wird oder keine Benutzertypen für den Typ des OLE-Elements registriert sind, wird der aktuell im OLE-Element gespeicherte Benutzertyp verwendet. Wenn dieser Benutzername eine leere Zeichenfolge ist, wird "Unknown Object" verwendet.

Weitere Informationen finden Sie unter "IOleObject::GetUserType " im Windows SDK.

COleClientItem::IsInPlaceActive

Rufen Sie diese Funktion auf, um festzustellen, ob das OLE-Element aktiv ist.

BOOL IsInPlaceActive() const;

Rückgabewert

Nonzero, wenn das OLE-Element aktiv ist; andernfalls 0.

Hinweise

Es ist üblich, unterschiedliche Logik auszuführen, je nachdem, ob das Element bearbeitet wird. Die Funktion überprüft, ob der aktuelle Elementstatus entweder dem activeState oder dem .activeUIState

COleClientItem::IsLinkUpToDate

Rufen Sie diese Funktion auf, um festzustellen, ob das OLE-Element auf dem neuesten Stand ist.

BOOL IsLinkUpToDate() const;

Rückgabewert

Nonzero, wenn das OLE-Element auf dem neuesten Stand ist; andernfalls 0.

Hinweise

Ein verknüpftes Element kann veraltet sein, wenn das Quelldokument aktualisiert wurde. Ein eingebettetes Element, das Verknüpfungen enthält, kann ebenfalls veraltet werden. Die Funktion führt eine rekursive Überprüfung des OLE-Elements durch. Beachten Sie, dass die Ermittlung, ob ein OLE-Element nicht mehr aktuell ist, so teuer sein kann, wie das Ausführen einer Aktualisierung.

Dies wird automatisch von der COleLinksDialog-Implementierung aufgerufen.

Weitere Informationen finden Sie unter "IOleObject::IsUpToDate " im Windows SDK.

COleClientItem::IsModified

Rufen Sie diese Funktion auf, um festzustellen, ob das OLE-Element geändert wurde (seit dem letzten Speichern geändert).

BOOL IsModified() const;

Rückgabewert

Nonzero, wenn das OLE-Element schmutzig ist; andernfalls 0.

Hinweise

Weitere Informationen finden Sie unter "IPersistStorage::IsDirty " im Windows SDK.

COleClientItem::IsOpen

Rufen Sie diese Funktion auf, um festzustellen, ob das OLE-Element geöffnet ist. d. h. in einer Instanz der Serveranwendung geöffnet, die in einem separaten Fenster ausgeführt wird.

BOOL IsOpen() const;

Rückgabewert

Nonzero, wenn das OLE-Element geöffnet ist; andernfalls 0.

Hinweise

Es wird verwendet, um zu bestimmen, wann das Objekt mit einem Schlupfmuster gezeichnet werden soll. Ein offenes Objekt sollte ein Schlupfmuster aufweisen, das über dem Objekt gezeichnet wird. Dazu können Sie ein CRectTracker-Objekt verwenden.

COleClientItem::IsRunning

Rufen Sie diese Funktion auf, um festzustellen, ob das OLE-Element ausgeführt wird. d. h., ob das Element in der Serveranwendung geladen und ausgeführt wird.

BOOL IsRunning() const;

Rückgabewert

Nonzero, wenn das OLE-Element ausgeführt wird; andernfalls 0.

Hinweise

Weitere Informationen finden Sie unter OleIsRunning im Windows SDK.

COleClientItem::OnActivate

Wird vom Framework aufgerufen, um das Element zu benachrichtigen, dass es gerade aktiviert wurde.

virtual void OnActivate();

Hinweise

Beachten Sie, dass diese Funktion aufgerufen wird, um anzugeben, dass der Server ausgeführt wird, und nicht, um anzugeben, dass seine Benutzeroberfläche in der Containeranwendung installiert wurde. An diesem Punkt verfügt das Objekt nicht über eine aktive Benutzeroberfläche (ist nicht activeUIState). Es hat seine Menüs oder Symbolleisten nicht installiert. Die OnActivateUI-Memberfunktion wird aufgerufen, wenn dies geschieht.

COleClientItem::OnActivateUI

Das Framework ruft auf OnActivateUI , wenn das Objekt den aktiven UI-Zustand eingegeben hat.

virtual void OnActivateUI();

Hinweise

Das Objekt hat nun die Symbolleiste und menüs installiert.

Die Standardimplementierung merkt sich den HWND des Servers für spätere GetServerWindow Aufrufe.

COleClientItem::OnChange

Wird vom Framework aufgerufen, wenn der Benutzer das OLE-Element ändert, speichert oder schließt.

virtual void OnChange(
    OLE_NOTIFICATION nCode,
    DWORD dwParam);

Parameter

nCode
Der Grund, warum der Server dieses Element geändert hat. Sie kann einen der folgenden Werte aufweisen:

OLE_CHANGED Die Darstellung des OLE-Elements wurde geändert.
OLE_SAVED Das OLE-Element wurde gespeichert.
OLE_CLOSED Das OLE-Element wurde geschlossen.
OLE_CHANGED_STATE Das OLE-Element wurde von einem Zustand in einen anderen geändert.

dwParam
Wenn nCode OLE_SAVED oder OLE_CLOSED ist, wird dieser Parameter nicht verwendet. Wenn nCode OLE_CHANGED ist, gibt dieser Parameter den Aspekt des GEÄNDERTen OLE-Elements an. Mögliche Werte finden Sie im dwParam-Parameter von COleClientItem::D raw. Wenn nCode OLE_CHANGED_STATE ist, ist dieser Parameter ein COleClientItem::ItemState Aufzählungswert und beschreibt den eingegebenen Zustand. Sie kann einen der folgenden Werte aufweisen: emptyState, , loadedState, , openState, , activeStateoder activeUIState.

Hinweise

(Wenn die Serveranwendung mithilfe der Microsoft Foundation Class Library geschrieben wird, wird diese Funktion als Reaktion auf die Notify Memberfunktionen von COleServerDoc oder COleServerItem.) Die Standardimplementierung kennzeichnet das Containerdokument als geändert, wenn nCode OLE_CHANGED oder OLE_SAVED ist.

Für OLE_CHANGED_STATE ist der aktuelle Zustand, der von GetItemState zurückgegeben wird, weiterhin der alte Zustand, d. h. der Zustand, der vor dieser Zustandsänderung aktuell war.

Überschreiben Sie diese Funktion, um auf Änderungen im Zustand des OLE-Elements zu reagieren. In der Regel aktualisieren Sie die Darstellung des Elements, indem Sie den Bereich ungültig machen, in dem das Element angezeigt wird. Rufen Sie die Basisklassenimplementierung am Anfang der Außerkraftsetzung auf.

COleClientItem::OnChangeItemPosition

Wird vom Framework aufgerufen, um den Container zu benachrichtigen, dass sich der Umfang des OLE-Elements während der direkten Aktivierung geändert hat.

virtual BOOL OnChangeItemPosition(const CRect& rectPos);

Parameter

rectPos
Gibt die Position des Elements relativ zum Clientbereich der Containeranwendung an.

Rückgabewert

Nonzero, wenn die Position des Elements erfolgreich geändert wird; andernfalls 0.

Hinweise

Die Standardimplementierung bestimmt das neue sichtbare Rechteck des OLE-Elements und ruft SetItemRects mit den neuen Werten auf. Die Standardimplementierung berechnet das sichtbare Rechteck für das Element und übergibt diese Informationen an den Server.

Überschreiben Sie diese Funktion, um spezielle Regeln auf den Größen-/Verschiebungsvorgang anzuwenden. Wenn die Anwendung in MFC geschrieben wird, führt dieser Aufruf dazu, dass der Server "COleServerDoc::RequestPositionChange" aufgerufen wird.

COleClientItem::OnDeactivate

Wird vom Framework aufgerufen, wenn das OLE-Element vom direkten aktiven Zustand ( activeState) in den geladenen Zustand wechselt, was bedeutet, dass es nach einer direkten Aktivierung deaktiviert wird.

virtual void OnDeactivate();

Hinweise

Beachten Sie, dass diese Funktion aufgerufen wird, um anzugeben, dass das OLE-Element geschlossen ist und nicht, dass die Benutzeroberfläche aus der Containeranwendung entfernt wurde. In diesem Fall wird die OnDeactivateUI-Memberfunktion aufgerufen.

Die Standardimplementierung ruft die OnChange-Memberfunktion mit OLE_CHANGEDSTATE als Parameter auf. Überschreiben Sie diese Funktion, um benutzerdefinierte Verarbeitung durchzuführen, wenn ein aktives Element an einem Ort deaktiviert wird. Wenn Sie beispielsweise den Befehl "Rückgängig" in Ihrer Containeranwendung unterstützen, können Sie diese Funktion außer Kraft setzen, um den Rückgängig-Zustand zu verwerfen, der angibt, dass der letzte ausgeführte Vorgang für das OLE-Element nicht rückgängig gemacht werden kann, nachdem das Element deaktiviert wurde.

COleClientItem::OnDeactivateAndUndo

Wird vom Framework aufgerufen, wenn der Benutzer den Rückgängig-Befehl aufruft, nachdem das OLE-Element aktiviert wurde.

virtual void OnDeactivateAndUndo();

Hinweise

Die Standardimplementierung ruft DeactivateUI auf, um die Benutzeroberfläche des Servers zu deaktivieren. Überschreiben Sie diese Funktion, wenn Sie den Befehl "Rückgängig" in Ihrer Containeranwendung implementieren. Rufen Sie in Ihrer Außerkraftsetzung die Basisklassenversion der Funktion auf, und rückgängigmachen Sie dann den letzten Befehl, der in Ihrer Anwendung ausgeführt wird.

Weitere Informationen finden Sie unter "IOleInPlaceSite::D eactivateAndUndo " im Windows SDK.

COleClientItem::OnDeactivateUI

Wird aufgerufen, wenn der Benutzer ein Element deaktiviert, das aktiviert wurde.

virtual void OnDeactivateUI(BOOL bUndoable);

Parameter

bUndoable
Gibt an, ob die Bearbeitungsänderungen rückgängig werden können.

Hinweise

Wenn "bUndoable " FALSCH ist, sollte der Container den Rückgängig-Befehl deaktivieren und den Rückgängig-Zustand des Containers verwerfen, da er angibt, dass der letzte vom Server ausgeführte Vorgang nicht rückgängig gemacht werden kann.

COleClientItem::OnDiscardUndoState

Wird vom Framework aufgerufen, wenn der Benutzer eine Aktion ausführt, die den Rückgängig-Zustand beim Bearbeiten des OLE-Elements verwirft.

virtual void OnDiscardUndoState();

Hinweise

Bei der Standardimplementierung wird keine Aktion ausgeführt. Überschreiben Sie diese Funktion, wenn Sie den Befehl "Rückgängig" in Ihrer Containeranwendung implementieren. Verwerfen Sie in Ihrer Außerkraftsetzung den Rückgängig-Zustand der Containeranwendung.

Wenn der Server mit der Microsoft Foundation Class Library geschrieben wurde, kann der Server dazu führen, dass diese Funktion durch Aufrufen von COleServerDoc::D iscardUndoState aufgerufen wird.

Weitere Informationen finden Sie unter "IOleInPlaceSite::D iscardUndoState " im Windows SDK.

COleClientItem::OnGetClipboardData

Wird vom Framework aufgerufen, um ein COleDataSource Objekt abzurufen, das alle Daten enthält, die durch einen Aufruf der CopyToClipboard- oder doDragDrop-Memberfunktion in der Zwischenablage platziert werden.

virtual COleDataSource* OnGetClipboardData(
    BOOL bIncludeLink,
    LPPOINT lpOffset,
    LPSIZE lpSize);

Parameter

bIncludeLink
Legen Sie diesen Wert auf TRUE fest, wenn Verknüpfungsdaten in die Zwischenablage kopiert werden sollen. Legen Sie diesen Wert auf FALSE fest, wenn die Serveranwendung keine Links unterstützt.

lpOffset
Zeigen Sie auf den Offset des Mauszeigers vom Ursprung des Objekts in Pixeln.

lpSize
Zeigen Sie auf die Größe des Objekts in Pixeln.

Rückgabewert

Ein Zeiger auf ein COleDataSource-Objekt , das die Zwischenablagedaten enthält.

Hinweise

Die Standardimplementierung dieser Funktion ruft GetClipboardData auf.

COleClientItem::OnGetClipRect

Das Framework ruft die OnGetClipRect Memberfunktion auf, um die Clippingrechteckkoordinaten des Elements abzurufen, das bearbeitet wird.

virtual void OnGetClipRect(CRect& rClipRect);

Parameter

rClipRect
Zeigen Sie auf ein Objekt der Klasse CRect , das die Clippingrechteckkoordinaten des Elements enthält.

Hinweise

Koordinaten sind in Pixeln relativ zum Clientbereich des Containeranwendungsfensters.

Die Standardimplementierung gibt einfach das Clientrechteck der Ansicht zurück, in der das Element aktiv ist.

COleClientItem::OnGetItemPosition

Das Framework ruft die OnGetItemPosition Memberfunktion auf, um die Koordinaten des Elements abzurufen, das bearbeitet wird.

virtual void OnGetItemPosition(CRect& rPosition);

Parameter

rPosition
Verweis auf das CRect-Objekt , das die Positionskoordinaten des Elements enthält.

Hinweise

Koordinaten sind in Pixeln relativ zum Clientbereich des Containeranwendungsfensters.

Bei der Standardimplementierung dieser Funktion wird keine Aktion ausgeführt. Anwendungen, die die direkte Bearbeitung unterstützen, erfordern die Implementierung.

COleClientItem::OnGetWindowContext

Wird vom Framework aufgerufen, wenn ein Element aktiviert wird.

virtual BOOL OnGetWindowContext(
    CFrameWnd** ppMainFrame,
    CFrameWnd** ppDocFrame,
    LPOLEINPLACEFRAMEINFO lpFrameInfo);

Parameter

ppMainFrame
Zeigen Sie auf einen Zeiger auf das Hauptrahmenfenster.

ppDocFrame
Zeigen Sie auf einen Zeiger auf das Dokumentrahmenfenster.

lpFrameInfo
Zeigen Sie auf eine OLEINPLACEFRAMEINFO-Struktur , die Framefensterinformationen empfängt.

Rückgabewert

Ungleich Null, wenn erfolgreich, andernfalls 0 (Null).

Hinweise

Diese Funktion wird verwendet, um Informationen zum übergeordneten Fenster des OLE-Elements abzurufen.

Wenn der Container eine MDI-Anwendung ist, gibt die Standardimplementierung einen Zeiger auf das CMDIFrameWnd-Objekt in ppMainFrame und einen Zeiger auf das aktive CMDIChildWnd-Objekt in ppDocFrame zurück. Wenn der Container eine SDI-Anwendung ist, gibt die Standardimplementierung einen Zeiger auf das CFrameWnd-Objekt in ppMainFrame zurück und gibt NULL in ppDocFrame zurück. Die Standardimplementierung füllt auch die Member von lpFrameInfo aus.

Überschreiben Sie diese Funktion nur, wenn die Standardimplementierung ihrer Anwendung nicht entspricht. Wenn Ihre Anwendung beispielsweise über ein Benutzeroberflächenparadigma verfügt, das sich von SDI oder MDI unterscheidet. Dies ist eine erweiterte Außerkraftsetzung.

Weitere Informationen finden Sie unter "IOleInPlaceSite::GetWindowContext " und der OLEINPLACEFRAMEINFO-Struktur im Windows SDK.

COleClientItem::OnInsertMenus

Das Framework wird während der direkten Aktivierung aufgerufen, um die Menüs der Containeranwendung in ein leeres Menü einzufügen.

virtual void OnInsertMenus(
    CMenu* pMenuShared,
    LPOLEMENUGROUPWIDTHS lpMenuWidths);

Parameter

pMenuShared
Zeigt auf ein leeres Menü.

lpMenuWidths
Verweist auf ein Array von sechs LONG-Werten, die angeben, wie viele Menüs in den folgenden Menügruppen enthalten sind: Datei, Bearbeiten, Container, Objekt, Fenster, Hilfe. Die Containeranwendung ist für die Menügruppen "Datei", "Container" und "Fenster" verantwortlich, die den Elementen 0, 2 und 4 dieses Arrays entsprechen.

Hinweise

Dieses Menü wird dann an den Server übergeben, der eigene Menüs einfügt und ein zusammengesetztes Menü erstellt. Diese Funktion kann wiederholt aufgerufen werden, um mehrere zusammengesetzte Menüs zu erstellen.

Die Standardimplementierung fügt in pMenuShared die direkten Containermenüs ein, d. h. die Menügruppen "Datei", "Container" und "Fenster". CDocTemplate::SetContainerInfo wird verwendet, um diese Menüressource festzulegen. Die Standardimplementierung weist je nach Menüressource auch die entsprechenden Werte den Elementen 0, 2 und 4 in lpMenuWidths zu. Überschreiben Sie diese Funktion, wenn die Standardimplementierung für Ihre Anwendung nicht geeignet ist; Wenn Ihre Anwendung z. B. keine Dokumentvorlagen zum Zuordnen von Ressourcen zu Dokumenttypen verwendet. Wenn Sie diese Funktion außer Kraft setzen, sollten Sie auch "OnSetMenu" und "OnRemoveMenus" außer Kraft setzen. Dies ist eine erweiterte Außerkraftsetzung.

Weitere Informationen finden Sie unter "IOleInPlaceFrame::InsertMenus " im Windows SDK.

COleClientItem::OnRemoveMenus

Vom Framework aufgerufen, um die Menüs des Containers aus dem angegebenen zusammengesetzten Menü zu entfernen, wenn die direkte Aktivierung endet.

virtual void OnRemoveMenus(CMenu* pMenuShared);

Parameter

pMenuShared
Verweist auf das zusammengesetzte Menü, das durch Aufrufe der OnInsertMenus-Memberfunktion erstellt wird.

Hinweise

Die Standardimplementierung entfernt pMenuShared die direkten Containermenüs, d. h. die Menügruppen "Datei", "Container" und "Fenster". Überschreiben Sie diese Funktion, wenn die Standardimplementierung für Ihre Anwendung nicht geeignet ist; Wenn Ihre Anwendung z. B. keine Dokumentvorlagen zum Zuordnen von Ressourcen zu Dokumenttypen verwendet. Wenn Sie diese Funktion außer Kraft setzen, sollten Sie wahrscheinlich auch OnInsertMenus und OnSetMenu überschreiben. Dies ist eine erweiterte Außerkraftsetzung.

Das Untermenü für pMenuShared kann von mehreren zusammengesetzten Menüs gemeinsam genutzt werden, wenn der Server wiederholt aufgerufen OnInsertMenuswurde. Daher sollten Sie in Ihrer Außerkraftsetzung OnRemoveMenuskeine Untermenüs löschen. Sie sollten sie nur trennen.

Weitere Informationen finden Sie unter "IOleInPlaceFrame::RemoveMenus " im Windows SDK.

COleClientItem::OnScrollBy

Wird vom Framework aufgerufen, um das OLE-Element als Reaktion auf Anforderungen vom Server zu scrollen.

virtual BOOL OnScrollBy(CSize sizeExtent);

Parameter

sizeExtent
Gibt die Entfernungen in Pixel an, um in den X- und Y-Richtungen zu scrollen.

Rückgabewert

Nonzero, wenn das Element gescrollt wurde; 0, wenn das Element nicht gescrollt werden konnte.

Hinweise

Wenn das OLE-Element z. B. teilweise sichtbar ist und der Benutzer während der direkten Bearbeitung außerhalb des sichtbaren Bereichs bewegt wird, wird diese Funktion aufgerufen, um den Cursor sichtbar zu halten. Bei der Standardimplementierung wird keine Aktion ausgeführt. Überschreiben Sie diese Funktion, um das Element um den angegebenen Betrag zu scrollen. Beachten Sie, dass sich der sichtbare Teil des OLE-Elements aufgrund eines Bildlaufs ändern kann. Rufen Sie SetItemRects auf, um das sichtbare Rechteck des Elements zu aktualisieren.

Weitere Informationen finden Sie unter "IOleInPlaceSite::Scroll " im Windows SDK.

COleClientItem::OnSetMenu

Vom Framework zweimal aufgerufen, wenn die direkte Aktivierung beginnt und endet; das erste Mal, um das zusammengesetzte Menü und das zweite Mal (mit Lochmenü gleich NULL) zu installieren, um es zu entfernen.

virtual void OnSetMenu(
    CMenu* pMenuShared,
    HOLEMENU holemenu,
    HWND hwndActiveObject);

Parameter

pMenuShared
Zeigen Sie auf das zusammengesetzte Menü, das durch Aufrufe der OnInsertMenus-Memberfunktion und der InsertMenu Funktion erstellt wird.

Lochmenü
Behandeln Sie den von der OleCreateMenuDescriptor Funktion zurückgegebenen Menüdeskriptor oder NULL, wenn der Verteilercode entfernt werden soll.

hwndActiveObject
Behandeln Sie das Bearbeitungsfenster für das OLE-Element. Dies ist das Fenster, das Bearbeitungsbefehle von OLE empfängt.

Hinweise

Die Standardimplementierung installiert oder entfernt das zusammengesetzte Menü und ruft dann die OleSetMenuDescriptor-Funktion auf, um den Verteilercode zu installieren oder zu entfernen. Überschreiben Sie diese Funktion, wenn die Standardimplementierung für Ihre Anwendung nicht geeignet ist. Wenn Sie diese Funktion außer Kraft setzen, sollten Sie wahrscheinlich auch OnInsertMenus und OnRemoveMenus außer Kraft setzen. Dies ist eine erweiterte Außerkraftsetzung.

Weitere Informationen finden Sie unter OleCreateMenuDescriptor, OleSetMenuDescriptor und IOleInPlaceFrame::SetMenu im Windows SDK.

COleClientItem::OnShowControlBars

Wird vom Framework aufgerufen, um die Steuerleisten der Containeranwendung anzuzeigen und auszublenden.

virtual BOOL OnShowControlBars(
    CFrameWnd* pFrameWnd,
    BOOL bShow);

Parameter

pFrameWnd
Zeigen Sie auf das Framefenster der Containeranwendung. Dies kann entweder ein Hauptrahmenfenster oder ein untergeordnetes MDI-Fenster sein.

bShow
Gibt an, ob Steuerleisten angezeigt oder ausgeblendet werden sollen.

Rückgabewert

Nonzero, wenn der Funktionsaufruf zu einer Änderung des Zustands der Steuerleisten führt; 0, wenn der Aufruf keine Änderung verursacht oder pFrameWnd nicht auf das Framefenster des Containers verweist.

Hinweise

Diese Funktion gibt 0 zurück, wenn sich die Steuerleisten bereits im durch bShow angegebenen Zustand befinden. Dies würde z. B. auftreten, wenn die Steuerleisten ausgeblendet sind und "bShow " FALSCH ist.

Die Standardimplementierung entfernt die Symbolleiste aus dem Framefenster der obersten Ebene.

COleClientItem::OnShowItem

Wird vom Framework aufgerufen, um das OLE-Element anzuzeigen, wodurch es während der Bearbeitung vollständig sichtbar wird.

virtual void OnShowItem();

Hinweise

Sie wird verwendet, wenn Ihre Containeranwendung Links zu eingebetteten Elementen unterstützt (d. h., wenn Sie Ihre Dokumentklasse von COleLinkingDoc abgeleitet haben). Diese Funktion wird während der direkten Aktivierung aufgerufen oder wenn das OLE-Element eine Linkquelle ist und der Benutzer sie bearbeiten möchte. Die Standardimplementierung aktiviert die erste Ansicht im Containerdokument. Überschreiben Sie diese Funktion, um das Dokument zu scrollen, damit das OLE-Element sichtbar ist.

COleClientItem::OnUpdateFrameTitle

Wird vom Framework während der direkten Aktivierung aufgerufen, um die Titelleiste des Framefensters zu aktualisieren.

virtual BOOL OnUpdateFrameTitle();

Rückgabewert

Nonzero, wenn diese Funktion den Frametitel erfolgreich aktualisiert hat, andernfalls Null.

Hinweise

Die Standardimplementierung ändert den Titel des Rahmenfensters nicht. Überschreiben Sie diese Funktion, wenn Sie einen anderen Frametitel für Ihre Anwendung wünschen, z. B. "Server-App-Element - im Docname" (wie in "Microsoft Excel - Kalkulationstabelle in REPORT.DOC"). Dies ist eine erweiterte Außerkraftsetzung.

COleClientItem::ReactivateAndUndo

Rufen Sie diese Funktion auf, um das OLE-Element zu reaktivieren und den letzten Vorgang rückgängig zu machen, der vom Benutzer während der direkten Bearbeitung ausgeführt wurde.

BOOL ReactivateAndUndo();

Rückgabewert

Ungleich Null, wenn erfolgreich, andernfalls 0 (Null).

Hinweise

Wenn Ihre Containeranwendung den Befehl "Rückgängig" unterstützt, rufen Sie diese Funktion auf, wenn der Benutzer den Befehl "Rückgängig" unmittelbar nach der Deaktivierung des OLE-Elements auswäht.

Wenn die Serveranwendung mit den Microsoft Foundation-Klassenbibliotheken geschrieben wird, bewirkt diese Funktion, dass der Server COleServerDoc::OnReactivateAndUndo aufruft.

Weitere Informationen finden Sie unter "IOleInPlaceObject::ReactivateAndUndo " im Windows SDK.

COleClientItem::Release

Rufen Sie diese Funktion auf, um ressourcen zu bereinigen, die vom OLE-Element verwendet werden.

virtual void Release(OLECLOSE dwCloseOption = OLECLOSE_NOSAVE);

Parameter

dwCloseOption
Flag, das angibt, unter welchen Umständen das OLE-Element gespeichert wird, wenn es in den geladenen Zustand zurückkehrt. Eine Liste der möglichen Werte finden Sie unter "COleClientItem::Close".

Hinweise

Release wird vom COleClientItem Destruktor aufgerufen.

Weitere Informationen finden Sie unter "IUnknown::Release " im Windows SDK.

COleClientItem::Reload

Schließt das Element und lädt es erneut.

BOOL Reload();

Rückgabewert

Ungleich Null, wenn erfolgreich, andernfalls 0 (Null).

Hinweise

Rufen Sie die Reload Funktion nach der Aktivierung des Elements als Element eines anderen Typs durch einen Aufruf von ActivateAs auf.

COleClientItem::Run

Führt die anwendung aus, die diesem Element zugeordnet ist.

void Run();

Hinweise

Rufen Sie die Run Memberfunktion auf, um die Serveranwendung zu starten, bevor Sie das Element aktivieren. Dies erfolgt automatisch durch Aktivieren und DoVerb, daher ist es in der Regel nicht erforderlich, diese Funktion aufzurufen. Rufen Sie diese Funktion auf, wenn es erforderlich ist, den Server auszuführen, um ein Elementattribut wie SetExtent festzulegen, bevor DoVerb ausgeführt wird.

COleClientItem::SetDrawAspect

Rufen Sie die SetDrawAspect Memberfunktion auf, um den "Aspekt" oder die Ansicht des Elements festzulegen.

virtual void SetDrawAspect(DVASPECT nDrawAspect);

Parameter

nDrawAspect
Ein Wert aus der DVASPECT-Aufzählung. Dieser Parameter kann einen der folgenden Werte aufweisen:

DVASPECT_CONTENT Element wird so dargestellt, dass es als eingebettetes Objekt innerhalb des Containers angezeigt werden kann.
DVASPECT_THUMBNAIL Element wird in einer "Miniaturansicht"-Darstellung gerendert, sodass es in einem Browsertool angezeigt werden kann.
DVASPECT_ICON Element wird durch ein Symbol dargestellt.
DVASPECT_DOCPRINT Element wird so dargestellt, als ob es mit dem Befehl "Drucken" aus dem Menü "Datei" gedruckt wurde.

Hinweise

Der Aspekt gibt an, wie das Element von Draw gerendert werden soll, wenn der Standardwert für das nDrawAspect-Argument dieser Funktion verwendet wird.

Diese Funktion wird automatisch durch das Änderungssymbol (und andere Dialogfelder, die das Dialogfeld "Symbol ändern" direkt aufrufen) aufgerufen, um den iconic-Anzeigeaspekt zu aktivieren, wenn er vom Benutzer angefordert wird.

COleClientItem::SetExtent

Rufen Sie diese Funktion auf, um anzugeben, wie viel Platz für das OLE-Element verfügbar ist.

void SetExtent(
    const CSize& size,
    DVASPECT nDrawAspect = DVASPECT_CONTENT);

Parameter

size
Ein CSize-Objekt, das die Größeninformationen enthält.

nDrawAspect
Gibt den Aspekt des OLE-Elements an, dessen Grenzen festgelegt werden sollen. Mögliche Werte finden Sie unter SetDrawAspect.

Hinweise

Wenn die Serveranwendung mit der Microsoft Foundation Class Library geschrieben wurde, wird dadurch die OnSetExtent-Memberfunktion des entsprechenden COleServerItem Objekts aufgerufen. Das OLE-Element kann dann die Anzeige entsprechend anpassen. Die Abmessungen müssen in MM_HIMETRIC Einheiten enthalten sein. Rufen Sie diese Funktion auf, wenn der Benutzer die Größe des OLE-Elements ändert oder wenn Sie eine Form der Layoutverhandlung unterstützen.

Weitere Informationen finden Sie unter "IOleObject::SetExtent " im Windows SDK.

COleClientItem::SetHostNames

Rufen Sie diese Funktion auf, um den Namen der Containeranwendung und den Namen des Containers für ein eingebettetes OLE-Element anzugeben.

void SetHostNames(
    LPCTSTR lpszHost,
    LPCTSTR lpszHostObj);

Parameter

lpszHost
Zeigen Sie auf den benutzer sichtbaren Namen der Containeranwendung.

lpszHostObj
Zeigen Sie auf eine identifizierende Zeichenfolge des Containers, der das OLE-Element enthält.

Hinweise

Wenn die Serveranwendung mithilfe der Microsoft Foundation-Klassenbibliothek geschrieben wurde, ruft diese Funktion die OnSetHostNames-Memberfunktion des COleServerDoc Dokuments auf, das das OLE-Element enthält. Diese Informationen werden in Fenstertiteln verwendet, wenn das OLE-Element bearbeitet wird. Jedes Mal, wenn ein Containerdokument geladen wird, ruft das Framework diese Funktion für alle OLE-Elemente im Dokument auf. SetHostNames gilt nur für eingebettete Elemente. Es ist nicht erforderlich, diese Funktion jedes Mal aufzurufen, wenn ein eingebettetes OLE-Element zur Bearbeitung aktiviert wird.

Dies wird auch automatisch mit dem Anwendungsnamen und dem Dokumentnamen aufgerufen, wenn ein Objekt geladen wird oder wenn eine Datei unter einem anderen Namen gespeichert wird. Dementsprechend ist es in der Regel nicht erforderlich, diese Funktion direkt aufzurufen.

Weitere Informationen finden Sie unter "IOleObject::SetHostNames " im Windows SDK.

COleClientItem::SetIconicMetafile

Speichert die metadatei zwischen, die zum Zeichnen des Elementssymbols verwendet wird.

BOOL SetIconicMetafile(HGLOBAL hMetaPict);

Parameter

hMetaPict
Ein Handle für die Metadatei, die zum Zeichnen des Elementssymbols verwendet wird.

Rückgabewert

Ungleich Null, wenn erfolgreich, andernfalls 0 (Null).

Hinweise

Verwenden Sie GetIconicMetafile , um die Metadatei abzurufen.

Der hMetaPict-Parameter wird in das Element kopiert. Daher muss hMetaPict vom Aufrufer freigegeben werden.

COleClientItem::SetItemRects

Rufen Sie diese Funktion auf, um das umgebende Rechteck oder das sichtbare Rechteck des OLE-Elements festzulegen.

BOOL SetItemRects(
    LPCRECT lpPosRect = NULL,
    LPCRECT lpClipRect = NULL);

Parameter

lprcPosRect
Zeigen Sie auf das Rechteck, das die Grenzen des OLE-Elements relativ zum übergeordneten Fenster enthält, in Clientkoordinaten.

lprcClipRect
Zeigen Sie auf das Rechteck, das die Grenzen des sichtbaren Teils des OLE-Elements relativ zum übergeordneten Fenster in Clientkoordinaten enthält.

Rückgabewert

Ungleich 0 (null), wenn erfolgreich, andernfalls 0 (null).

Hinweise

Diese Funktion wird von der Standardimplementierung der OnChangeItemPosition-Memberfunktion aufgerufen. Sie sollten diese Funktion immer dann aufrufen, wenn sich die Position oder der sichtbare Teil des OLE-Elements ändert. In der Regel bedeutet dies, dass Sie sie über die OnSize - und OnScrollBy-Memberfunktionen Ihrer Ansicht aufrufen.

Weitere Informationen finden Sie unter "IOleInPlaceObject::SetObjectRects " im Windows SDK.

COleClientItem::SetLinkUpdateOptions

Rufen Sie diese Funktion auf, um die Linkaktualisierungsoption für die Darstellung des angegebenen verknüpften Elements festzulegen.

void SetLinkUpdateOptions(OLEUPDATE dwUpdateOpt);

Parameter

dwUpdateOpt
Der Wert der Linkaktualisierungsoption für dieses Element. Dieser Wert muss eine der folgenden Werte sein:

OLEUPDATE_ALWAYS Aktualisieren des verknüpften Elements nach Möglichkeit. Diese Option unterstützt das Optionsfeld "Automatische Verknüpfungsaktualisierung" im Dialogfeld "Links".
OLEUPDATE_ONCALL Aktualisieren sie das verknüpfte Element nur auf Anforderung aus der Containeranwendung (wenn die UpdateLink-Memberfunktion aufgerufen wird). Diese Option unterstützt das Optionsfeld "Manuelle Verknüpfungsaktualisierung" im Dialogfeld "Links".

Hinweise

In der Regel sollten Sie die updateoptionen, die der Benutzer im Dialogfeld "Links" ausgewählt hat, nicht ändern.

Weitere Informationen finden Sie unter "IOleLink::SetUpdateOptions" im Windows SDK.

COleClientItem::SetPrintDevice

Rufen Sie diese Funktion auf, um das Druckzielgerät für dieses Element zu ändern.

BOOL SetPrintDevice(const DVTARGETDEVICE* ptd);
BOOL SetPrintDevice(const PRINTDLG* ppd);

Parameter

Ptd
Zeiger auf eine DVTARGETDEVICE-Datenstruktur , die Informationen zum neuen Druckzielgerät enthält. Kann den Wert NULL haben.

ppd
Zeiger auf eine PRINTDLG-Datenstruktur , die Informationen zum neuen Druckzielgerät enthält. Kann den Wert NULL haben.

Rückgabewert

Nonzero, wenn die Funktion erfolgreich war; andernfalls 0.

Hinweise

Diese Funktion aktualisiert das Druckzielgerät für das Element, aktualisiert aber nicht den Präsentationscache. Rufen Sie UpdateLink auf, um den Präsentationscache für ein Element zu aktualisieren.

Die Argumente für diese Funktion enthalten Informationen, die das OLE-System zum Identifizieren des Zielgeräts verwendet. Die PRINTDLG Struktur enthält Informationen, die Windows zum Initialisieren des allgemeinen Dialogfelds "Drucken" verwendet. Nachdem der Benutzer das Dialogfeld geschlossen hat, gibt Windows Informationen über die Auswahl des Benutzers in dieser Struktur zurück. Das m_pd Element eines CPrintDialog-Objekts ist eine PRINTDLG Struktur.

Weitere Informationen zu dieser Struktur finden Sie unter PRINTDLG im Windows SDK.

Weitere Informationen finden Sie unter DVTARGETDEVICE im Windows SDK.

COleClientItem::UpdateLink

Rufen Sie diese Funktion auf, um die Präsentationsdaten des OLE-Elements sofort zu aktualisieren.

BOOL UpdateLink();

Rückgabewert

Bei Erfolg ein Wert ungleich 0 (null), andernfalls 0 (null).

Hinweise

Bei verknüpften Elementen findet die Funktion die Verknüpfungsquelle, um eine neue Präsentation für das OLE-Element abzurufen. Dieser Vorgang kann die Ausführung einer oder mehrerer Serveranwendungen umfassen, was zeitaufwändig sein kann. Bei eingebetteten Elementen wird die Funktion rekursiv ausgeführt, und es wird überprüft, ob das eingebettete Element Verknüpfungen enthält, die möglicherweise nicht mehr aktuell sind und aktualisiert werden. Der Benutzer kann einzelne Links auch manuell über das Dialogfeld "Links" aktualisieren.

Weitere Informationen finden Sie unter "IOleLink::Update " im Windows SDK.

Siehe auch

MFC-Beispiel MFCBIND
MFC-Beispiel-OCLIENT
CDocItem-Klasse
Hierarchiediagramm
COleServerItem-Klasse

Freigeben über

COleClientItem-Klasse

Syntax

Member

Öffentliche Konstruktoren

Öffentliche Methoden

Geschützte Methoden

Hinweise

Vererbungshierarchie

Anforderungen

COleClientItem::Activate

Parameter

Hinweise

COleClientItem::ActivateAs

Parameter

Rückgabewert

Hinweise

COleClientItem::AttachDataObject

Parameter

COleClientItem::CanActivate

Rückgabewert

Hinweise

COleClientItem::CanCreateFromData

Parameter

Rückgabewert

Hinweise

COleClientItem::CanCreateLinkFromData

Parameter

Rückgabewert

Hinweise

COleClientItem::CanPaste

Rückgabewert

Hinweise

COleClientItem::CanPasteLink

Rückgabewert

Hinweise

COleClientItem::Close

Parameter

Hinweise

COleClientItem::COleClientItem

Parameter

Hinweise

COleClientItem::ConvertTo

Parameter

Rückgabewert

Hinweise

COleClientItem::CopyToClipboard

Parameter

Hinweise

COleClientItem::CreateCloneFrom

Parameter

Rückgabewert

Hinweise

COleClientItem::CreateFromClipboard

Parameter

Rückgabewert

Hinweise

COleClientItem::CreateFromData

Parameter

Rückgabewert

Hinweise

COleClientItem::CreateFromFile

Parameter

Rückgabewert

Hinweise

COleClientItem::CreateLinkFromClipboard

Parameter

Rückgabewert

Hinweise

COleClientItem::CreateLinkFromData

Parameter

Rückgabewert

Hinweise

COleClientItem::CreateLinkFromFile

Parameter

Rückgabewert

Hinweise

COleClientItem::CreateNewItem

Parameter

Rückgabewert