COlePropertyPage-Klasse

  • Artikel

Wird verwendet, um die Eigenschaften eines benutzerdefinierten Steuerelements in einer grafischen Oberfläche anzuzeigen, ähnlich wie in einem Dialogfeld.

Syntax

class AFX_NOVTABLE COlePropertyPage : public CDialog

Member

Öffentliche Konstruktoren

Name Beschreibung
COlePropertyPage::COlePropertyPage Erstellt ein COlePropertyPage-Objekt.

Öffentliche Methoden

Name Beschreibung
COlePropertyPage::GetControlStatus Gibt an, ob der Benutzer den Wert im Steuerelement geändert hat.
COlePropertyPage::GetObjectArray Gibt das Array von Objekten zurück, die von der Eigenschaftenseite bearbeitet werden.
COlePropertyPage::GetPageSite Gibt einen Zeiger auf die Schnittstelle der Eigenschaftenseite IPropertyPageSite zurück.
COlePropertyPage::IgnoreApply Bestimmt, welche Steuerelemente die Schaltfläche "Übernehmen" nicht aktivieren.
COlePropertyPage::IsModified Gibt an, ob der Benutzer die Eigenschaftenseite geändert hat.
COlePropertyPage::OnEditProperty Wird vom Framework aufgerufen, wenn der Benutzer eine Eigenschaft bearbeitet.
COlePropertyPage::OnHelp Wird vom Framework aufgerufen, wenn der Benutzer Hilfe aufruft.
COlePropertyPage::OnInitDialog Wird vom Framework aufgerufen, wenn die Eigenschaftenseite initialisiert wird.
COlePropertyPage::OnObjectsChanged Wird vom Framework aufgerufen, wenn ein anderes OLE-Steuerelement mit neuen Eigenschaften ausgewählt wird.
COlePropertyPage::OnSetPageSite Wird vom Framework aufgerufen, wenn der Eigenschaftenframe die Website der Seite bereitstellt.
COlePropertyPage::SetControlStatus Legt ein Kennzeichen fest, das angibt, ob der Benutzer den Wert im Steuerelement geändert hat.
COlePropertyPage::SetDialogResource Legt die Dialogressource der Eigenschaftenseite fest.
COlePropertyPage::SetHelpInfo Legt den kurzen Hilfetext der Eigenschaftenseite, den Namen der Hilfedatei und den Hilfekontext fest.
COlePropertyPage::SetModifiedFlag Legt ein Flag fest, das angibt, ob der Benutzer die Eigenschaftenseite geändert hat.
COlePropertyPage::SetPageName Legt den Namen der Eigenschaftenseite (Untertitel) fest.

Hinweise

Beispielsweise kann eine Eigenschaftenseite ein Bearbeitungssteuerelement enthalten, mit dem der Benutzer die Untertitel Eigenschaft des Steuerelements anzeigen und ändern kann.

Jede benutzerdefinierte eigenschaft oder stock control can have a dialog control that allows the control's user to view the current property value and modify that value if needed.

Weitere Informationen zur Verwendung COlePropertyPagefinden Sie im Artikel ActiveX-Steuerelemente: Eigenschaftenseiten.

Vererbungshierarchie

CObject

CCmdTarget

CWnd

Cdialog

COlePropertyPage

Anforderungen

Kopfzeile: afxctl.h

COlePropertyPage::COlePropertyPage

Erstellt ein COlePropertyPage-Objekt.

COlePropertyPage(
    UINT idDlg,
    UINT idCaption);

Parameter

idDlg
Ressourcen-ID der Dialogfeldvorlage.

idCaption
Ressourcen-ID der Untertitel der Eigenschaftenseite.

Hinweise

Wenn Sie eine Unterklasse implementierenCOlePropertyPage, sollte der Konstruktor Ihrer Unterklasse den COlePropertyPage Konstruktor verwenden, um die Dialogvorlagenressource zu identifizieren, auf der die Eigenschaftenseite basiert, und die Zeichenfolgenressource, die ihre Untertitel enthält.

COlePropertyPage::GetControlStatus

Bestimmt, ob der Benutzer den Wert des Eigenschaftenseitensteuerelements mit der angegebenen Ressourcen-ID geändert hat.

BOOL GetControlStatus(UINT nID);

Parameter

Nid
Ressourcen-ID eines Eigenschaftenseitensteuerelements.

Rückgabewert

TRUE, wenn der Steuerelementwert geändert wurde; andernfalls FALSE.

COlePropertyPage::GetObjectArray

Gibt das Array von Objekten zurück, die von der Eigenschaftenseite bearbeitet werden.

LPDISPATCH* GetObjectArray(ULONG* pnObjects);

Parameter

pnObjects
Zeigen Sie auf eine nicht signierte lange ganze Zahl, die die Anzahl der Objekte empfängt, die von der Seite bearbeitet werden.

Rückgabewert

Zeiger auf ein Array von IDispatch Zeigern, die für den Zugriff auf die Eigenschaften jedes Steuerelements auf der Eigenschaftenseite verwendet werden. Der Aufrufer darf diese Schnittstellenzeiger nicht freigeben.

Hinweise

Jedes Eigenschaftenseitenobjekt Standard enthält ein Array von Zeigern auf die IDispatch Schnittstellen der Objekte, die von der Seite bearbeitet werden. Diese Funktion legt das pnObjects-Argument auf die Anzahl der Elemente in diesem Array fest und gibt einen Zeiger auf das erste Element des Arrays zurück.

COlePropertyPage::GetPageSite

Ruft einen Zeiger auf die Schnittstelle der Eigenschaftenseite IPropertyPageSite ab.

LPPROPERTYPAGESITE GetPageSite();

Rückgabewert

Ein Zeiger auf die Schnittstelle der Eigenschaftenseite IPropertyPageSite .

Hinweise

Steuerelemente und Container arbeiten zusammen, damit Benutzer Steuerelementeigenschaften durchsuchen und bearbeiten können. Das Steuerelement stellt Eigenschaftenseiten bereit, von denen jedes ein OLE-Objekt ist, mit dem der Benutzer einen verwandten Satz von Eigenschaften bearbeiten kann. Der Container stellt einen Eigenschaftsrahmen bereit, der die Eigenschaftenseiten anzeigt. Für jede Seite stellt der Eigenschaftenrahmen eine Seitenwebsite bereit, die die IPropertyPageSite Schnittstelle unterstützt.

COlePropertyPage::IgnoreApply

Bestimmt, welche Steuerelemente die Schaltfläche "Übernehmen" nicht aktivieren.

void IgnoreApply(UINT nID);

Parameter

Nid
ID des zu ignorierenden Steuerelements.

Hinweise

Die Schaltfläche "Übernehmen" der Eigenschaftenseite ist nur aktiviert, wenn Die Werte von Eigenschaftenseitensteuerelementen geändert wurden. Verwenden Sie diese Funktion, um Steuerelemente anzugeben, die nicht dazu führen, dass die Schaltfläche "Übernehmen" aktiviert wird, wenn sich ihre Werte ändern.

COlePropertyPage::IsModified

Bestimmt, ob der Benutzer Werte auf der Eigenschaftenseite geändert hat.

BOOL IsModified();

Rückgabewert

TRUE, wenn die Eigenschaftenseite geändert wurde.

COlePropertyPage::OnEditProperty

Das Framework ruft diese Funktion auf, wenn eine bestimmte Eigenschaft bearbeitet werden soll.

virtual BOOL OnEditProperty(DISPID dispid);

Parameter

Dispid
Verteiler-ID der eigenschaft, die bearbeitet wird.

Rückgabewert

Die Standardimplementierung gibt FALSE zurück. Überschreibungen dieser Funktion sollten TRUE zurückgeben.

Hinweise

Sie können ihn überschreiben, um den Fokus auf das entsprechende Steuerelement auf der Seite festzulegen. Die Standardimplementierung führt nichts aus und gibt FALSE zurück.

COlePropertyPage::OnHelp

Das Framework ruft diese Funktion auf, wenn der Benutzer Onlinehilfe anfordert.

virtual BOOL OnHelp(LPCTSTR lpszHelpDir);

Parameter

lpszHelpDir
Verzeichnis, das die Hilfedatei der Eigenschaftenseite enthält.

Rückgabewert

Die Standardimplementierung gibt FALSE zurück.

Hinweise

Überschreiben Sie sie, wenn ihre Eigenschaftenseite eine spezielle Aktion ausführen muss, wenn der Benutzer auf die Hilfe zugreift. Die Standardimplementierung führt nichts aus und gibt FALSE zurück, wodurch das Framework anweist, WinHelp aufzurufen.

COlePropertyPage::OnInitDialog

Das Framework ruft diese Funktion auf, wenn das Dialogfeld der Eigenschaftenseite initialisiert wird.

virtual BOOL OnInitDialog();

Rückgabewert

Die Standardimplementierung gibt FALSE zurück.

Hinweise

Überschreiben Sie sie, wenn eine spezielle Aktion erforderlich ist, wenn das Dialogfeld initialisiert wird. Die Standardimplementierung ruft false zurück CDialog::OnInitDialog und gibt FALSE zurück.

COlePropertyPage::OnObjectsChanged

Wird vom Framework aufgerufen, wenn ein anderes OLE-Steuerelement mit neuen Eigenschaften ausgewählt wird.

virtual void OnObjectsChanged();

Hinweise

Beim Anzeigen der Eigenschaften eines OLE-Steuerelements in der Entwicklerumgebung wird ein dialogfeld ohne Modus verwendet, um dessen Eigenschaftenseiten anzuzeigen. Wenn ein anderes Steuerelement ausgewählt ist, muss für den neuen Eigenschaftensatz ein anderer Satz von Eigenschaftenseiten angezeigt werden. Das Framework ruft diese Funktion auf, um die Eigenschaftenseite der Änderung zu benachrichtigen.

Überschreiben Sie diese Funktion, um Benachrichtigungen über diese Aktion zu erhalten und spezielle Aktionen auszuführen.

COlePropertyPage::OnSetPageSite

Das Framework ruft diese Funktion auf, wenn der Eigenschaftenframe die Seitenwebsite der Eigenschaftenseite bereitstellt.

virtual void OnSetPageSite();

Hinweise

Die Standardimplementierung lädt die Untertitel der Seite und versucht, die Größe der Seite aus der Dialogressource zu ermitteln. Überschreiben Sie diese Funktion, wenn ihre Eigenschaftenseite weitere Aktionen erfordert. Ihre Außerkraftsetzung sollte die Basisklassenimplementierung aufrufen.

COlePropertyPage::SetControlStatus

Ändert den Status eines Eigenschaftenseitensteuerelements.

BOOL SetControlStatus(
    UINT nID,
    BOOL bDirty);

Parameter

Nid
Enthält die ID eines Eigenschaftenseitensteuerelements.

bDirty
Gibt an, ob ein Feld der Eigenschaftenseite geändert wurde. Wird auf TRUE festgelegt, wenn das Feld geändert wurde, FALSE, wenn es nicht geändert wurde.

Rückgabewert

TRUE, wenn das angegebene Steuerelement festgelegt wurde; andernfalls FALSE.

Hinweise

Wenn der Status eines Eigenschaftenseitensteuerelements modifiziert wird, wenn die Eigenschaftenseite geschlossen oder die Schaltfläche "Anwenden" ausgewählt wird, wird die Eigenschaft des Steuerelements mit dem entsprechenden Wert aktualisiert.

COlePropertyPage::SetDialogResource

Legt die Dialogressource der Eigenschaftenseite fest.

void SetDialogResource(HGLOBAL hDialog);

Parameter

hDialog
Behandeln sie die Dialogressource der Eigenschaftenseite.

COlePropertyPage::SetHelpInfo

Gibt QuickInfo-Informationen, den Hilfedateinamen und den Hilfekontext für Ihre Eigenschaftenseite an.

void SetHelpInfo(
    LPCTSTR lpszDocString,
    LPCTSTR lpszHelpFile = NULL,
    DWORD dwHelpContext = 0);

Parameter

lpszDocString
Eine Zeichenfolge mit kurzen Hilfeinformationen für die Anzeige in einer Statusleiste oder an einem anderen Ort.

lpszHelpFile
Name der Hilfedatei der Eigenschaftenseite.

dwHelpContext
Hilfekontext für die Eigenschaftenseite.

COlePropertyPage::SetModifiedFlag

Gibt an, ob der Benutzer die Eigenschaftenseite geändert hat.

void SetModifiedFlag(BOOL bModified = TRUE);

Parameter

bModified
Gibt den neuen Wert für das geänderte Flag der Eigenschaftenseite an.

COlePropertyPage::SetPageName

Legt den Namen der Eigenschaftenseite fest, den der Eigenschaftenrahmen normalerweise auf der Registerkarte der Seite anzeigt.

void SetPageName(LPCTSTR lpszPageName);

Parameter

lpszPageName
Zeigen Sie auf eine Zeichenfolge, die den Namen der Eigenschaftenseite enthält.

Siehe auch

MFC-Beispiel CIRC3
MFC-BeispielTESTHELP
CDialog-Klasse
Hierarchiediagramm
CDialog-Klasse