Freigeben über


CSnapInPropertyPageImpl-Klasse

Diese Klasse stellt Methoden zum Implementieren eines Snap-In-Eigenschaftenseitenobjekts bereit.

Wichtig

Diese Klasse und ihre Member können nicht in Anwendungen verwendet werden, die in der Windows-Runtime ausgeführt werden.

Syntax

CSnapInPropertyPageImpl : public CDialogImplBase

Member

Öffentliche Konstruktoren

Name Beschreibung
CSnapInPropertyPageImpl::CSnapInPropertyPageImpl Konstruktor.

Öffentliche Methoden

Name Beschreibung
CSnapInPropertyPageImpl::CancelToClose Ändert den Status der Schaltflächen "OK " und "Abbrechen ".
CSnapInPropertyPageImpl::Create Initialisiert ein neu erstelltes CSnapInPropertyPageImpl Objekt.
CSnapInPropertyPageImpl::OnApply Wird vom Framework aufgerufen, wenn der Benutzer bei Verwendung eines Eigenschaftenblatts vom Assistenten auf die Schaltfläche "Jetzt anwenden" klickt.
CSnapInPropertyPageImpl::OnHelp Wird vom Framework aufgerufen, wenn der Benutzer bei Verwendung eines Eigenschaftenblatts vom Assistenten auf die Schaltfläche "Hilfe " klickt.
CSnapInPropertyPageImpl::OnKillActive Wird vom Framework aufgerufen, wenn die aktuelle Seite nicht mehr aktiv ist.
CSnapInPropertyPageImpl::OnQueryCancel Wird vom Framework aufgerufen, wenn der Benutzer auf die Schaltfläche "Abbrechen " klickt und bevor der Abbruch erfolgt ist.
CSnapInPropertyPageImpl::OnReset Wird vom Framework aufgerufen, wenn der Benutzer bei Verwendung eines Eigenschaftenblatts vom Assistenten auf die Schaltfläche "Zurücksetzen " klickt.
CSnapInPropertyPageImpl::OnSetActive Wird vom Framework aufgerufen, wenn die aktuelle Seite aktiv wird.
CSnapInPropertyPageImpl::OnWizardBack Wird vom Framework aufgerufen, wenn der Benutzer bei Verwendung eines Eigenschaftenblatts vom Assistenten auf die Schaltfläche "Zurück " klickt.
CSnapInPropertyPageImpl::OnWizardFinish Wird vom Framework aufgerufen, wenn der Benutzer bei Verwendung eines Eigenschaftenblatts vom Assistenten auf die Schaltfläche "Fertig stellen " klickt.
CSnapInPropertyPageImpl::OnWizardNext Wird vom Framework aufgerufen, wenn der Benutzer bei Verwendung eines Eigenschaftenblatts vom Assistenten auf die Schaltfläche "Weiter " klickt.
CSnapInPropertyPageImpl::QuerySiblings Leitet die aktuelle Nachricht an alle Seiten des Eigenschaftenblatts weiter.
CSnapInPropertyPageImpl::SetModified Rufen Sie auf, um die Schaltfläche "Jetzt anwenden " zu aktivieren oder zu deaktivieren.

Öffentliche Datenmember

Name Beschreibung
CSnapInPropertyPageImpl::m_psp Die vom CSnapInPropertyPageImpl Objekt verwendete Windows-StrukturPROPSHEETPAGE.

Hinweise

CSnapInPropertyPageImpl stellt eine grundlegende Implementierung für ein Snap-In-Eigenschaftenseitenobjekt bereit. Die grundlegenden Features einer Snap-In-Eigenschaftenseite werden mithilfe verschiedener Schnittstellen und Kartentypen implementiert.

Vererbungshierarchie

CDialogImplBase

CSnapInPropertyPageImpl

Anforderungen

Kopfzeile: atlsnap.h

CSnapInPropertyPageImpl::CancelToClose

Rufen Sie diese Funktion auf, nachdem eine nicht wiederherstellbare Änderung an den Daten auf einer Seite eines modalen Eigenschaftenblatts vorgenommen wurde.

void CancelToClose();

Hinweise

Mit dieser Funktion wird die Schaltfläche "OK " in "Schließen " geändert und die Schaltfläche "Abbrechen " deaktiviert. Diese Änderung benachrichtigt den Benutzer, dass eine Änderung dauerhaft ist und die Änderungen nicht abgebrochen werden können.

Die CancelToClose Memberfunktion führt in einem moduslosen Eigenschaftenblatt nichts aus, da in einem moduslosen Eigenschaftenblatt standardmäßig keine Schaltfläche "Abbrechen " vorhanden ist.

CSnapInPropertyPageImpl::CSnapInPropertyPageImpl

Erstellt ein CSnapInPropertyPageImpl-Objekt.

CSnapInPropertyPageImpl(LPCTSTR lpszTitle = NULL);

Parameter

lpszTitle
[in] Der Titel der Eigenschaftenseite.

Hinweise

Rufen Sie zum Initialisieren der zugrunde liegenden Struktur CSnapInPropertyPageImpl::Create auf.

CSnapInPropertyPageImpl::Create

Rufen Sie diese Funktion auf, um die zugrunde liegende Struktur der Eigenschaftenseite zu initialisieren.

HPROPSHEETPAGE Create();

Rückgabewert

Ein Handle zu einer PROPSHEETPAGE Struktur, die die Attribute des neu erstellten Eigenschaftenblatts enthält.

Hinweise

Sie sollten zuerst CSnapInPropertyPageImpl::CSnapInPropertyPageImpl aufrufen, bevor Sie diese Funktion aufrufen.

CSnapInPropertyPageImpl::m_psp

m_psp ist eine Struktur, deren Member die Merkmale von PROPSHEETPAGE.

PROPSHEETPAGE m_psp;

Hinweise

Verwenden Sie diese Struktur, um die Darstellung einer Eigenschaftenseite zu initialisieren, nachdem sie erstellt wurde.

Weitere Informationen zu dieser Struktur, einschließlich einer Auflistung seiner Mitglieder, finden Sie unter PROPSHEETPAGE im Windows SDK.

CSnapInPropertyPageImpl::OnApply

Diese Memberfunktion wird aufgerufen, wenn der Benutzer auf die Schaltfläche "OK " oder auf die Schaltfläche "Jetzt anwenden " klickt.

BOOL OnApply();

Rückgabewert

Nonzero, wenn die Änderungen akzeptiert werden; andernfalls 0.

Hinweise

Bevor OnApply sie vom Framework aufgerufen werden kann, müssen Sie den Parameter auf TRUE aufrufen SetModified und festlegen. Dadurch wird die Schaltfläche "Jetzt anwenden" aktiviert, sobald der Benutzer eine Änderung auf der Eigenschaftenseite vor nimmt.

Überschreiben Sie diese Memberfunktion, um anzugeben, welche Aktion ihr Programm ausführt, wenn der Benutzer auf die Schaltfläche "Jetzt anwenden" klickt. Beim Überschreiben sollte die Funktion WAHR zurückgeben, um Änderungen zu akzeptieren, und FALSE, um zu verhindern, dass Änderungen wirksam werden.

Die Standardimplementierung von OnApply "TRUE" gibt WAHR zurück.

CSnapInPropertyPageImpl::OnHelp

Diese Memberfunktion wird aufgerufen, wenn der Benutzer auf die Schaltfläche "Hilfe " für die Eigenschaftenseite klickt.

void OnHelp();

Hinweise

Überschreiben Sie diese Memberfunktion, um Hilfe für die Eigenschaftenseite anzuzeigen.

CSnapInPropertyPageImpl::OnKillActive

Diese Memberfunktion wird aufgerufen, wenn die Seite nicht mehr die aktive Seite ist.

BOOL OnKillActive();

Rückgabewert

Nonzero, wenn Daten erfolgreich aktualisiert wurden; andernfalls 0.

Hinweise

Überschreiben Sie diese Memberfunktion, um spezielle Datenüberprüfungsaufgaben auszuführen.

CSnapInPropertyPageImpl::OnQueryCancel

Diese Memberfunktion wird aufgerufen, wenn der Benutzer auf die Schaltfläche "Abbrechen " klickt und bevor die Abbruchaktion ausgeführt wurde.

BOOL OnQueryCancel();

Rückgabewert

Nonzero, um den Abbruchvorgang zuzulassen; andernfalls 0.

Hinweise

Überschreiben Sie diese Memberfunktion, um eine Aktion anzugeben, die das Programm ausführt, wenn der Benutzer auf die Schaltfläche "Abbrechen " klickt.

Die Standardimplementierung von OnQueryCancel "TRUE" gibt WAHR zurück.

CSnapInPropertyPageImpl::OnReset

Diese Memberfunktion wird aufgerufen, wenn der Benutzer auf die Schaltfläche "Abbrechen " klickt.

void OnReset();

Hinweise

Wenn diese Funktion aufgerufen wird, werden Änderungen an allen Eigenschaftenseiten, die der Benutzer zuvor auf die Schaltfläche "Jetzt anwenden" vorgenommen hat, verworfen, und das Eigenschaftenblatt behält den Fokus.

Überschreiben Sie diese Memberfunktion, um anzugeben, welche Aktion das Programm ausführt, wenn der Benutzer auf die Schaltfläche "Abbrechen " klickt.

CSnapInPropertyPageImpl::OnSetActive

Diese Memberfunktion wird aufgerufen, wenn die Seite vom Benutzer ausgewählt wird und zur aktiven Seite wird.

BOOL OnSetActive();

Rückgabewert

Nonzero, wenn die Seite erfolgreich aktiviert wurde; andernfalls 0.

Hinweise

Überschreiben Sie diese Memberfunktion, um Aufgaben auszuführen, wenn eine Seite aktiviert wird. Ihre Außerkraftsetzung dieser Memberfunktion sollte die Standardversion aufrufen, bevor eine andere Verarbeitung erfolgt.

Die Standardimplementierung gibt TRUE zurück.

CSnapInPropertyPageImpl::OnWizardBack

Diese Memberfunktion wird aufgerufen, wenn der Benutzer auf die Schaltfläche "Zurück " in einem Assistenten klickt.

BOOL OnWizardBack();

Rückgabewert

  • 0, um automatisch zur vorherigen Seite zu wechseln.

  • -1, um zu verhindern, dass die Seite geändert wird.

Um zu einer anderen Seite als der nächsten zu springen, geben Sie den Bezeichner des anzuzeigenden Dialogfelds zurück.

Hinweise

Überschreiben Sie diese Memberfunktion, um eine Aktion anzugeben, die der Benutzer ausführen muss, wenn auf die Schaltfläche "Zurück " geklickt wird.

CSnapInPropertyPageImpl::OnWizardFinish

Diese Memberfunktion wird aufgerufen, wenn der Benutzer in einem Assistenten auf die Schaltfläche "Fertig stellen " klickt.

BOOL OnWizardFinish();

Rückgabewert

Nonzero, wenn das Eigenschaftenblatt zerstört wird, wenn der Assistent abgeschlossen ist; andernfalls 0.

Hinweise

Überschreiben Sie diese Memberfunktion, um eine Aktion anzugeben, die der Benutzer ausführen muss, wenn auf die Schaltfläche "Fertig stellen " geklickt wird.

CSnapInPropertyPageImpl::OnWizardNext

Diese Memberfunktion wird aufgerufen, wenn der Benutzer in einem Assistenten auf die Schaltfläche "Weiter " klickt.

BOOL OnWizardNext();

Rückgabewert

  • 0, um automatisch zur nächsten Seite zu wechseln.

  • -1, um zu verhindern, dass die Seite geändert wird.

Um zu einer anderen Seite als der nächsten zu springen, geben Sie den Bezeichner des anzuzeigenden Dialogfelds zurück.

Hinweise

Überschreiben Sie diese Memberfunktion, um eine Aktion anzugeben, die der Benutzer ausführen muss, wenn auf die Schaltfläche "Weiter " geklickt wird.

CSnapInPropertyPageImpl::QuerySiblings

Rufen Sie diese Memberfunktion auf, um eine Nachricht an jede Seite im Eigenschaftenblatt weiterzuleiten.

LRESULT QuerySiblings(WPARAM wParam, LPARAM lParam);

Parameter

wParam
[in] Gibt zusätzliche nachrichtenabhängige Informationen an.

lParam
[in] Gibt zusätzliche nachrichtenabhängige Informationen an.

Rückgabewert

Nonzero, wenn die Nachricht nicht an die nächste Eigenschaftenseite weitergeleitet werden soll; andernfalls 0.

Hinweise

Wenn eine Seite einen Wert ungleich Null zurückgibt, sendet das Eigenschaftenblatt die Nachricht nicht an nachfolgende Seiten.

CSnapInPropertyPageImpl::SetModified

Rufen Sie diese Memberfunktion auf, um die Schaltfläche "Jetzt anwenden" zu aktivieren oder zu deaktivieren, je nachdem, ob die Einstellungen auf der Eigenschaftenseite auf das entsprechende externe Objekt angewendet werden sollen.

void SetModified(BOOL bChanged = TRUE);

Parameter

bChanged
[in] TRUE, um anzugeben, dass die Eigenschaftenseiteneinstellungen seit der letzten Anwendung geändert wurden; FALSE, um anzugeben, dass die Eigenschaftenseiteneinstellungen angewendet wurden oder ignoriert werden sollen.

Hinweise

Das Eigenschaftenblatt verfolgt, welche Seiten "schmutzig" sind, d. h. Eigenschaftenseiten, für die Sie aufgerufen SetModified( TRUE )haben. Die Schaltfläche "Jetzt anwenden " wird immer aktiviert, wenn Sie eine der Seiten aufrufen SetModified( TRUE ) . Die Schaltfläche "Jetzt anwenden" wird deaktiviert, wenn Sie eine der Seiten aufrufen SetModified( FALSE ) , aber nur, wenn keine der anderen Seiten "schmutzig" ist.

Siehe auch

Klassenübersicht