Klasa COlePropertyPage

Służy do wyświetlania właściwości kontrolki niestandardowej w interfejsie graficznym, podobnie jak w oknie dialogowym.

Składnia

class AFX_NOVTABLE COlePropertyPage : public CDialog

Członkowie

Konstruktory publiczne

Nazwa/nazwisko	opis
COlePropertyPage::COlePropertyPage	COlePropertyPage Tworzy obiekt.

Metody publiczne

Nazwa/nazwisko	opis
COlePropertyPage::GetControlStatus	Wskazuje, czy użytkownik zmodyfikował wartość w kontrolce.
COlePropertyPage::GetObjectArray	Zwraca tablicę obiektów edytowanych przez stronę właściwości.
COlePropertyPage::GetPageSite	Zwraca wskaźnik do interfejsu IPropertyPageSite strony właściwości.
COlePropertyPage::IgnoreApply	Określa, które kontrolki nie włączają przycisku Zastosuj.
COlePropertyPage::IsModified	Wskazuje, czy użytkownik zmodyfikował stronę właściwości.
COlePropertyPage::OnEditProperty	Wywoływana przez platformę, gdy użytkownik edytuje właściwość.
COlePropertyPage::OnHelp	Wywoływana przez platformę, gdy użytkownik wywołuje pomoc.
COlePropertyPage::OnInitDialog	Wywoływana przez platformę po zainicjowaniu strony właściwości.
COlePropertyPage::OnObjectsChanged	Wywoływana przez strukturę, gdy zostanie wybrana inna kontrolka OLE z nowymi właściwościami.
COlePropertyPage::OnSetPageSite	Wywoływana przez platformę, gdy ramka właściwości udostępnia witrynę strony.
COlePropertyPage::SetControlStatus	Ustawia flagę wskazującą, czy użytkownik zmodyfikował wartość w kontrolce.
COlePropertyPage::SetDialogResource	Ustawia zasób okna dialogowego strony właściwości.
COlePropertyPage::SetHelpInfo	Ustawia krótki tekst pomocy strony właściwości, nazwę pliku pomocy i kontekst pomocy.
COlePropertyPage::SetModifiedFlag	Ustawia flagę wskazującą, czy użytkownik zmodyfikował stronę właściwości.
COlePropertyPage::SetPageName	Ustawia nazwę strony właściwości (podpis).

Uwagi

Na przykład strona właściwości może zawierać kontrolkę edycji, która umożliwia użytkownikowi wyświetlanie i modyfikowanie właściwości podpis kontrolki.

Każda właściwość kontrolki niestandardowej lub stockowej może mieć kontrolkę okna dialogowego, która umożliwia użytkownikowi kontrolki wyświetlanie bieżącej wartości właściwości i modyfikowanie tej wartości w razie potrzeby.

Aby uzyskać więcej informacji na temat korzystania z programu COlePropertyPage, zobacz artykuł ActiveX Controls: Property Pages (Kontrolki ActiveX: strony właściwości).

Hierarchia dziedziczenia

Cobject

Ccmdtarget

Cwnd

Cdialog

COlePropertyPage

Wymagania

Nagłówek: afxctl.h

COlePropertyPage::COlePropertyPage

COlePropertyPage Tworzy obiekt.

COlePropertyPage(
    UINT idDlg,
    UINT idCaption);

Parametry

idDlg
Identyfikator zasobu szablonu okna dialogowego.

idCaption
Identyfikator zasobu podpis strony właściwości.

Uwagi

Podczas implementowania podklasy COlePropertyPagekonstruktor podklasy powinien używać COlePropertyPage konstruktora do identyfikowania zasobu szablonu okna dialogowego, na którym jest oparta strona właściwości, oraz zasobu ciągu zawierającego jego podpis.

COlePropertyPage::GetControlStatus

Określa, czy użytkownik zmodyfikował wartość kontrolki strony właściwości za pomocą określonego identyfikatora zasobu.

BOOL GetControlStatus(UINT nID);

Parametry

Nid
Identyfikator zasobu kontrolki strony właściwości.

Wartość zwracana

WARTOŚĆ TRUE, jeśli wartość kontrolki została zmodyfikowana; w przeciwnym razie FAŁSZ.

COlePropertyPage::GetObjectArray

Zwraca tablicę obiektów edytowanych przez stronę właściwości.

LPDISPATCH* GetObjectArray(ULONG* pnObjects);

Parametry

pnObjects
Wskaźnik do niepodpisanej długiej liczby całkowitej, która będzie otrzymywać liczbę obiektów edytowanych przez stronę.

Wartość zwracana

Wskaźnik do tablicy IDispatch wskaźników, które są używane do uzyskiwania dostępu do właściwości każdej kontrolki na stronie właściwości. Obiekt wywołujący nie może zwolnić tych wskaźników interfejsu.

Uwagi

Każdy obiekt strony właściwości przechowuje tablicę wskaźników do IDispatch interfejsów obiektów edytowanych przez stronę. Ta funkcja ustawia argument pnObjects na liczbę elementów w tej tablicy i zwraca wskaźnik do pierwszego elementu tablicy.

COlePropertyPage::GetPageSite

Pobiera wskaźnik do interfejsu IPropertyPageSite strony właściwości.

LPPROPERTYPAGESITE GetPageSite();

Wartość zwracana

Wskaźnik do interfejsu IPropertyPageSite strony właściwości.

Uwagi

Kontrolki i kontenery współpracują, aby użytkownicy mogli przeglądać i edytować właściwości kontrolki. Kontrolka udostępnia strony właściwości, z których każdy jest obiektem OLE, który umożliwia użytkownikowi edytowanie powiązanego zestawu właściwości. Kontener zawiera ramkę właściwości, która wyświetla strony właściwości. Dla każdej strony ramka właściwości udostępnia witrynę strony, która obsługuje IPropertyPageSite interfejs.

COlePropertyPage::IgnoreApply

Określa, które kontrolki nie włączają przycisku Zastosuj.

void IgnoreApply(UINT nID);

Parametry

Nid
Identyfikator kontrolki, która ma być ignorowana.

Uwagi

Przycisk Zastosuj strony właściwości jest włączony tylko wtedy, gdy wartości kontrolek strony właściwości zostały zmienione. Ta funkcja służy do określania kontrolek, które nie powodują włączenia przycisku Zastosuj po zmianie ich wartości.

COlePropertyPage::IsModified

Określa, czy użytkownik zmienił jakiekolwiek wartości na stronie właściwości.

BOOL IsModified();

Wartość zwracana

Wartość TRUE, jeśli strona właściwości została zmodyfikowana.

COlePropertyPage::OnEditProperty

Struktura wywołuje tę funkcję, gdy ma zostać edytowana określona właściwość.

virtual BOOL OnEditProperty(DISPID dispid);

Parametry

Dispid
Identyfikator wysyłania edytowanej właściwości.

Wartość zwracana

Domyślna implementacja zwraca wartość FALSE. Przesłonięcia tej funkcji powinny zwracać wartość TRUE.

Uwagi

Można go zastąpić, aby ustawić fokus na odpowiednią kontrolkę na stronie. Domyślna implementacja nic nie robi i zwraca wartość FALSE.

COlePropertyPage::OnHelp

Platforma wywołuje tę funkcję, gdy użytkownik żąda pomocy online.

virtual BOOL OnHelp(LPCTSTR lpszHelpDir);

Parametry

lpszHelpDir
Katalog zawierający plik pomocy strony właściwości.

Wartość zwracana

Domyślna implementacja zwraca wartość FALSE.

Uwagi

Zastąpi ją, jeśli strona właściwości musi wykonać dowolną specjalną akcję, gdy użytkownik uzyskuje dostęp do pomocy. Domyślna implementacja nie wykonuje żadnych operacji i zwraca wartość FALSE, co instruuje platformę w celu wywołania metody WinHelp.

COlePropertyPage::OnInitDialog

Struktura wywołuje tę funkcję po zainicjowaniu okna dialogowego strony właściwości.

virtual BOOL OnInitDialog();

Wartość zwracana

Domyślna implementacja zwraca wartość FALSE.

Uwagi

Zastąpij ją, jeśli jest wymagana jakakolwiek akcja specjalna po zainicjowaniu okna dialogowego. Domyślne wywołania CDialog::OnInitDialog implementacji i zwraca wartość FALSE.

COlePropertyPage::OnObjectsChanged

Wywoływana przez strukturę, gdy zostanie wybrana inna kontrolka OLE z nowymi właściwościami.

virtual void OnObjectsChanged();

Uwagi

Podczas wyświetlania właściwości kontrolki OLE w środowisku dewelopera do wyświetlania stron właściwości służy okno dialogowe bez moderowania. Jeśli wybrano inną kontrolkę, dla nowego zestawu właściwości musi być wyświetlany inny zestaw stron właściwości. Struktura wywołuje tę funkcję, aby powiadomić stronę właściwości zmiany.

Zastąpi tę funkcję, aby otrzymywać powiadomienia o tej akcji i wykonywać wszelkie akcje specjalne.

COlePropertyPage::OnSetPageSite

Struktura wywołuje tę funkcję, gdy ramka właściwości udostępnia witrynę strony strony właściwości.

virtual void OnSetPageSite();

Uwagi

Domyślna implementacja ładuje podpis strony i próbuje określić rozmiar strony z zasobu okna dialogowego. Zastąpi tę funkcję, jeśli strona właściwości wymaga dalszych działań; zastąpienie powinno wywołać implementację klasy bazowej.

COlePropertyPage::SetControlStatus

Zmienia stan kontrolki strony właściwości.

BOOL SetControlStatus(
    UINT nID,
    BOOL bDirty);

Parametry

Nid
Zawiera identyfikator kontrolki strony właściwości.

bDirty
Określa, czy pole strony właściwości zostało zmodyfikowane. Ustaw wartość TRUE, jeśli pole zostało zmodyfikowane, wartość FALSE, jeśli nie została zmodyfikowana.

Wartość zwracana

PRAWDA, jeśli określona kontrolka została ustawiona; w przeciwnym razie FAŁSZ.

Uwagi

Jeśli stan kontrolki strony właściwości jest zanieczyszczony po zamknięciu strony właściwości lub zostanie wybrany przycisk Zastosuj, właściwość kontrolki zostanie zaktualizowana o odpowiednią wartość.

COlePropertyPage::SetDialogResource

Ustawia zasób okna dialogowego strony właściwości.

void SetDialogResource(HGLOBAL hDialog);

Parametry

hDialog
Dojmij do zasobu okna dialogowego strony właściwości.

COlePropertyPage::SetHelpInfo

Określa informacje o etykietce narzędzia, nazwę pliku pomocy i kontekst pomocy dla strony właściwości.

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

Parametry

lpszDocString
Ciąg zawierający krótkie informacje pomocy dotyczące wyświetlania na pasku stanu lub w innej lokalizacji.

lpszHelpFile
Nazwa pliku pomocy strony właściwości.

dwHelpContext
Kontekst pomocy dla strony właściwości.

COlePropertyPage::SetModifiedFlag

Wskazuje, czy użytkownik zmodyfikował stronę właściwości.

void SetModifiedFlag(BOOL bModified = TRUE);

Parametry

bModified
Określa nową wartość zmodyfikowanej flagi strony właściwości.

COlePropertyPage::SetPageName

Ustawia nazwę strony właściwości, którą ramka właściwości będzie zwykle wyświetlana na karcie strony.

void SetPageName(LPCTSTR lpszPageName);

Parametry

lpszPageName
Wskaźnik do ciągu zawierającego nazwę strony właściwości.

Zobacz też

Przykład MFC CIRC3
Przykład MFC TESTHELP
Klasa CDialog
Wykres hierarchii
Klasa CDialog