Udostępnij przez


Klasa CMFCPropertyGridProperty

Obiekt CMFCPropertyGridProperty reprezentuje element listy w kontrolce listy właściwości.

Aby uzyskać więcej informacji, zobacz kod źródłowy znajdujący się w mfc folderze instalacji programu Visual Studio. Na przykład %ProgramFiles(x86)%\Microsoft Visual Studio\2019\Enterprise\VC\Tools\MSVC\14.29.30133\atlmfc\src\mfc.

Składnia

class CMFCPropertyGridProperty : public CObject

Członkowie

Konstruktory publiczne

Nazwa/nazwisko opis
CMFCPropertyGridProperty::CMFCPropertyGridProperty CMFCPropertyGridProperty Tworzy obiekt.
CMFCPropertyGridProperty::~CMFCPropertyGridProperty Destruktora.

Metody publiczne

Nazwa/nazwisko opis
CMFCPropertyGridProperty::AddOption Dodaje nowy element listy do kontrolki listy właściwości.
CMFCPropertyGridProperty::AddSubItem Dodaje element podrzędny do właściwości.
CMFCPropertyGridProperty::AdjustButtonRect Wywoływana przez kontrolkę listy właściwości nadrzędnych, aby poinformować właściwość o zmianie rozmiaru prostokąta ograniczenia osadzonego przycisku.
CMFCPropertyGridProperty::AdjustInPlaceEditRect Pobiera granice pola tekstowego i opcjonalne kontrolki przycisku pokrętła, które są używane do ustawiania wartości właściwości.
CMFCPropertyGridProperty::AllowEdit Tworzy właściwość edytowalną lub tylko do odczytu.
CMFCPropertyGridProperty::CreateInPlaceEdit Wywoływana przez platformę w celu utworzenia kontrolki edytowalnej dla właściwości.
CMFCPropertyGridProperty::CreateSpinControl Wywoływana przez strukturę w celu utworzenia edytowalnej kontrolki przycisku pokrętła.
CMFCPropertyGridProperty::Enable Włącza lub wyłącza właściwość.
CMFCPropertyGridProperty::EnableSpinControl Włącza lub wyłącza kontrolkę przycisku spin, która jest używana do modyfikowania wartości właściwości.
CMFCPropertyGridProperty::Expand Rozwija lub zwija właściwość zawierającą podwłaściwości.
CMFCPropertyGridProperty::FormatProperty Formatuje tekstową reprezentację wartości właściwości.
CMFCPropertyGridProperty::GetData Pobiera wartość DWORD skojarzona z właściwością.
CMFCPropertyGridProperty::GetDescription Pobiera opis właściwości.
CMFCPropertyGridProperty::GetExpandedSubItems Pobiera liczbę rozszerzonych subitemów.
CMFCPropertyGridProperty::GetHierarchyLevel Pobiera indeks zerowy poziomu hierarchii właściwości.
CMFCPropertyGridProperty::GetName Pobiera nazwę właściwości.
CMFCPropertyGridProperty::GetNameTooltip Wywoływana przez platformę w celu wyświetlenia nazwy właściwości w etykietce narzędzia.
CMFCPropertyGridProperty::GetOption Pobiera tekst opcji określonej przez indeks.
CMFCPropertyGridProperty::GetOptionCount Pobiera liczbę opcji należących do właściwości.
CMFCPropertyGridProperty::GetOriginalValue Pobiera początkową wartość bieżącej właściwości.
CMFCPropertyGridProperty::GetParent Pobiera wskaźnik do właściwości nadrzędnej.
CMFCPropertyGridProperty::GetRect Pobiera prostokąt ograniczenia właściwości.
CMFCPropertyGridProperty::GetSubItem Pobiera właściwość podrzędną zidentyfikowaną przez indeks oparty na zerze.
CMFCPropertyGridProperty::GetSubItemsCount Pobiera liczbę elementów podrzędnych.
CMFCPropertyGridProperty::GetThisClass Używany przez platformę do uzyskiwania wskaźnika do obiektu skojarzonego CRuntimeClass z tym typem klasy.
CMFCPropertyGridProperty::GetValue Pobiera wartość właściwości.
CMFCPropertyGridProperty::GetValueTooltip Wywoływana przez platformę w celu pobrania tekstowej reprezentacji wartości właściwości, która jest następnie wyświetlana w etykietce narzędzia.
CMFCPropertyGridProperty::HitTest Wskazuje obiekt właściwości odpowiadający elementowi listy właściwości, który odpowiada punktowi.
CMFCPropertyGridProperty::IsAllowEdit Wskazuje, czy właściwość jest edytowalna.
CMFCPropertyGridProperty::IsEnabled Wskazuje, czy właściwość jest włączona, czy wyłączona.
CMFCPropertyGridProperty::IsExpanded Wskazuje, czy właściwość jest rozwinięta, czy zwinięta.
CMFCPropertyGridProperty::IsGroup Wskazuje, czy bieżąca właściwość reprezentuje grupę.
CMFCPropertyGridProperty::IsInPlaceEditing Wskazuje, czy bieżąca właściwość jest edytowalna.
CMFCPropertyGridProperty::IsModified Wskazuje, czy bieżąca właściwość jest modyfikowana.
CMFCPropertyGridProperty::IsParentExpanded Wskazuje, czy częścią nadrzędną bieżącej właściwości są rozwinięte.
CMFCPropertyGridProperty::IsSelected Wskazuje, czy wybrano bieżącą właściwość.
CMFCPropertyGridProperty::IsVisible Wskazuje, czy bieżąca właściwość jest widoczna.
CMFCPropertyGridProperty::OnClickButton Wywoływana przez platformę, gdy użytkownik wybierze przycisk zawarty we właściwości.
CMFCPropertyGridProperty::OnClickName Wywoływana przez kontrolkę listy właściwości nadrzędnych, gdy użytkownik wybierze pole nazwy właściwości.
CMFCPropertyGridProperty::OnClickValue Wywoływana przez kontrolkę listy właściwości nadrzędnych, gdy użytkownik wybierze pole wartości właściwości.
CMFCPropertyGridProperty::OnCloseCombo Wywoływana przez platformę, gdy pole kombi zawarte we właściwości jest zamknięte.
CMFCPropertyGridProperty::OnDblClk Wywoływana przez platformę, gdy użytkownik dwukrotnie kliknie właściwość.
CMFCPropertyGridProperty::OnDrawButton Wywoływana przez strukturę w celu narysowania przycisku, który znajduje się we właściwości.
CMFCPropertyGridProperty::OnDrawDescription Wywoływana przez strukturę w celu wyświetlenia opisu właściwości.
CMFCPropertyGridProperty::OnDrawExpandBox Wywoływana przez strukturę w celu rysowania kontrolki rozwiń pole w pobliżu właściwości, która zawiera właściwości podrzędne.
CMFCPropertyGridProperty::OnDrawName Wywoływana przez strukturę w celu wyświetlenia nazwy właściwości.
CMFCPropertyGridProperty::OnDrawValue Wywoływana przez platformę w celu wyświetlenia wartości właściwości.
CMFCPropertyGridProperty::OnEdit Wywoływana przez platformę, gdy użytkownik ma zmodyfikować wartość właściwości.
CMFCPropertyGridProperty::OnEndEdit Wywoływana przez platformę po zakończeniu modyfikowania wartości właściwości przez użytkownika.
CMFCPropertyGridProperty::OnKillSelection
CMFCPropertyGridProperty::OnPosSizeChanged
CMFCPropertyGridProperty::OnRClickName Wywoływana przez platformę, gdy użytkownik wybierze prawy przycisk myszy w obszarze nazwy właściwości.
CMFCPropertyGridProperty::OnRClickValue Wywoływana przez platformę, gdy użytkownik wybierze prawy przycisk myszy w obszarze wartości właściwości.
CMFCPropertyGridProperty::OnSelectCombo Wywoływana przez platformę, gdy użytkownik wybiera element z edytowalnego pola kombi.
CMFCPropertyGridProperty::OnSetCursor Wywoływana przez strukturę, gdy wskaźnik myszy przechodzi do elementu właściwości.
CMFCPropertyGridProperty::OnSetSelection
CMFCPropertyGridProperty::OnUpdateValue Wywoływana przez strukturę, gdy wartość właściwości edytowalnej uległa zmianie.
CMFCPropertyGridProperty::PushChar Wywoływana z kontrolki listy właściwości, gdy właściwość jest zaznaczona, a użytkownik wprowadza nowy znak.
CMFCPropertyGridProperty::Redraw Ponownie rysuje właściwość .
CMFCPropertyGridProperty::RemoveAllOptions Usuwa wszystkie opcje (elementy) z właściwości.
CMFCPropertyGridProperty::RemoveSubItem Usuwa określony element podrzędny.
CMFCPropertyGridProperty::ResetOriginalValue Przywraca oryginalną wartość edytowanej właściwości.
CMFCPropertyGridProperty::SetData Kojarzy wartość DWORD z właściwością.
CMFCPropertyGridProperty::SetDescription Określa tekst opisujący bieżącą właściwość.
CMFCPropertyGridProperty::SetName Ustawia nazwę właściwości.
CMFCPropertyGridProperty::SetOriginalValue Ustawia oryginalną wartość właściwości edytowalnej.
CMFCPropertyGridProperty::SetValue Ustawia wartość właściwości siatki właściwości.
CMFCPropertyGridProperty::Show Pokazuje lub ukrywa właściwość.

Metody chronione

Nazwa/nazwisko opis
CMFCPropertyGridProperty::CreateCombo Wywoływana przez strukturę w celu dodania pola kombi do właściwości.
CMFCPropertyGridProperty::HasButton Wskazuje, czy właściwość zawiera przycisk.
CMFCPropertyGridProperty::Init Wywoływana przez strukturę w celu zainicjowania obiektu właściwości.
CMFCPropertyGridProperty::IsSubItem Wskazuje, czy określona właściwość jest subitem bieżącej właściwości.
CMFCPropertyGridProperty::IsValueChanged Wskazuje, czy wartość bieżącej właściwości uległa zmianie.
CMFCPropertyGridProperty::OnCtlColor Wywoływana przez strukturę, gdy musi pobrać szczotkę, aby wypełnić kolor tła właściwości.
CMFCPropertyGridProperty::OnDestroyWindow Wywoływana przez platformę, gdy właściwość zostanie zniszczona lub po zakończeniu edycji.
CMFCPropertyGridProperty::OnKillFocus Wywoływana przez platformę, gdy właściwość traci fokus wejściowy.

Składowe danych

Nazwa/nazwisko opis
CMFCPropertyGridProperty::m_strFormatDouble Formatuj ciąg dla wartości typu podwójnej.
CMFCPropertyGridProperty::m_strFormatFloat Formatuj ciąg dla wartości typu float.
CMFCPropertyGridProperty::m_strFormatLong Formatuj ciąg dla wartości typu długiego.
CMFCPropertyGridProperty::m_strFormatShort Formatuj ciąg dla wartości typu krótkiego.

Uwagi

Użyj obiektu do reprezentowania CMFCPropertyGridProperty właściwości, którą następnie dodajesz do kontrolki listy właściwości. Aby uzyskać więcej informacji, zobacz CMFCPropertyGridCtrl Klasa.

Obiekt właściwości może reprezentować typy danych, takie jak ciągi, daty i wartości logiczne lub całkowite. Może zawierać właściwości podrzędne lub może zawierać kontrolkę, taką jak pole kombi lub kontrolka przycisku.

Przykład

W poniższym przykładzie pokazano, jak utworzyć CMFCPropertyGridProperty obiekt. W przykładzie pokazano również, jak używać różnych metod w klasie, CMFCPropertyGridProperty aby dodać opcję, dodać poditem, włączyć właściwość i pokazać właściwość. Ten przykład jest częścią przykładu Nowe kontrolki.

CMFCPropertyGridProperty *pGroup1 = new CMFCPropertyGridProperty(_T("Appearance"));

// construct a COleVariant object.
COleVariant var3DLook((short)VARIANT_FALSE, VT_BOOL);

pGroup1->AddSubItem(new CMFCPropertyGridProperty(_T("3D Look"), var3DLook,
                                                 _T("Specifies the dialog's font will be nonbold and controls will have a 3D border")));

CMFCPropertyGridProperty *pProp = new CMFCPropertyGridProperty(_T("Border"),
                                                               _T("Dialog Frame"), _T("One of: None, Thin, Resizable, or Dialog Frame"));
pProp->AddOption(_T("None"));
pProp->AddOption(_T("Thin"));
pProp->AddOption(_T("Resizable"));
pProp->AddOption(_T("Dialog Frame"));
pProp->AllowEdit(FALSE);

pGroup1->AddSubItem(pProp);
pGroup1->AddSubItem(new CMFCPropertyGridProperty(_T("Caption"), (COleVariant) _T("About NewControlsDemo"), _T("Specifies the text that will be displayed in the dialog's title bar")));
pGroup1->AdjustButtonRect();
pGroup1->AllowEdit();
pGroup1->Enable();
pGroup1->Show();
pGroup1->Redraw();

Hierarchia dziedziczenia

CObject

CMFCPropertyGridProperty

Wymagania

Nagłówka:afxpropertygridctrl.h

CMFCPropertyGridProperty::AddOption

Dodaje nowy element listy do kontrolki listy właściwości.

BOOL AddOption(
    LPCTSTR lpszOption,
    BOOL bInsertUnique=TRUE);

Parametry

lpszOption
[in] Element listy (opcja), który ma zostać dodany.

bInsertUnique
[in] TRUE aby dodać element listy tylko wtedy, gdy jeszcze nie istnieje; w przeciwnym razie, FALSE. Wartość domyślna to TRUE.

Wartość zwracana

TRUE, co oznacza, że element listy jest dodawany. W przeciwnym razie , co oznacza, że element listy nie jest dodawany, FALSEponieważ parametr jest TRUE i element listy określony przez lpszOptionbInsertUnique parametr już istnieje.

CMFCPropertyGridProperty::AddSubItem

Dodaje element podrzędny do właściwości.

BOOL AddSubItem(CMFCPropertyGridProperty* pProp);

Parametry

pProp
[in] Wskaźnik do właściwości do dodania.

Wartość zwracana

TRUE jeśli określona właściwość została pomyślnie dodana jako właściwość podrzędna. FALSE jeśli właściwość nie zostanie dodana, ponieważ już występuje we właściwości nadrzędnej.

Uwagi

Użyj tej metody, aby utworzyć hierarchiczną listę właściwości nadrzędnych i podrzędnych. Po dodaniu właściwości podrzędnej właściwość nadrzędna automatycznie wyświetla kontrolkę pola rozwijania wyznaczonego przez znak plus (+). Gdy użytkownik wybierze znak plus, właściwość nadrzędna zostanie rozwinięta i wyświetli wszystkie elementy właściwości podrzędnej.

CMFCPropertyGridProperty::AdjustButtonRect

Wywoływana przez kontrolkę listy właściwości nadrzędnych, aby poinformować właściwość o zmianie rozmiaru prostokąta ograniczenia osadzonego przycisku.

virtual void AdjustButtonRect();

Uwagi

Domyślnie ta metoda:

  • Dostosowuje szerokość przycisku równą wysokości przycisku oraz trzech pikseli.
  • Przenosi prostokąt ograniczenia przycisku do prawej krawędzi właściwości.
  • Przesuwa przycisk 1 piksel poniżej górnej krawędzi właściwości.

CMFCPropertyGridProperty::AdjustInPlaceEditRect

Pobiera granice pola tekstowego i opcjonalne kontrolki przycisku pokrętła, które są używane do ustawiania wartości właściwości.

virtual void AdjustInPlaceEditRect(
    CRect& rectEdit,
    CRect& rectSpin);

Parametry

rectEdit
[out] Gdy ta metoda zwraca, prostokąt określający granice pola tekstowego dla wartości właściwości.

rectSpin
[out] Gdy ta metoda zwróci, prostokąt określający granice kontrolki przycisku pokrętła dla wartości właściwości. Lub jeśli właściwość nie obsługuje przycisku pokrętła, pusty prostokąt.

Uwagi

Obszar wartości właściwości składa się z pola tekstowego i ewentualnie przycisku opcji, takiego jak kontrolka przycisku pokrętła. Ta metoda oblicza wymiary pola tekstowego i przycisku opcji, a następnie zwraca te wartości w określonych parametrach.

CMFCPropertyGridProperty::AllowEdit

Tworzy właściwość edytowalną lub tylko do odczytu.

void AllowEdit(BOOL bAllow=TRUE);

Parametry

bAllow
[in] TRUE w celu edytowania właściwości; FALSE aby ustawić właściwość tylko do odczytu. Wartość domyślna to TRUE.

CMFCPropertyGridProperty::CMFCPropertyGridProperty

CMFCPropertyGridProperty Tworzy obiekt.

CMFCPropertyGridProperty(
    const CString& strGroupName,
    DWORD_PTR dwData=0,
    BOOL bIsValueList=FALSE);

CMFCPropertyGridProperty(
    const CString& strName,
    const _variant_t& varValue,
    LPCTSTR lpszDescr=NULL,
    DWORD_PTR dwData=0,
    LPCTSTR lpszEditMask=NULL,
    LPCTSTR lpszEditTemplate=NULL,
    LPCTSTR lpszValidChars=NULL);

Parametry

strGroupName
[in] Nazwa grupy. Grupa jest kolekcją powiązanych właściwości w kontrolce siatki właściwości. Jeśli kontrolka jest wyświetlana hierarchicznie, nazwa grupy jest wyświetlana jako tytuł kategorii w wierszu powyżej grupy.

dwData
[in] Dane specyficzne dla aplikacji, takie jak liczba całkowita lub wskaźnik do innych danych skojarzonych z właściwością. Wartość domyślna to 0.

strName
[in] Nazwa właściwości.

varValue
[in] Wartość właściwości.

lpszDescr
[in] Opis właściwości. Wartość domyślna to NULL.

lpszEditMask
[in] Maska edycji, jeśli właściwość jest maskowaną kontrolką edycji. Wartość domyślna to NULL.

lpszEditTemplate
[in] Szablon edycji, jeśli właściwość jest maskowaną kontrolką edycji. Wartość domyślna to NULL.

lpszValidChars
[in] Lista prawidłowych znaków, jeśli właściwość jest maskowaną kontrolką edycji. Wartość domyślna to NULL.

bIsValueList
[in] TRUE jeśli właściwość reprezentuje listę wartości; FALSE jeśli właściwość reprezentuje pojedynczą wartość. Wartość domyślna to FALSE.

CMFCPropertyGridProperty::CreateCombo

Wywoływana przez strukturę w celu dodania pola kombi do właściwości.

virtual CComboBox* CreateCombo(
    CWnd* pWndParent,
    CRect rect);

Parametry

pWndParent
[in] Wskaźnik do okna nadrzędnego pola kombi.

rect
[in] Prostokąt ograniczenia pola kombi.

Wartość zwracana

Wskaźnik do nowego CComboBox obiektu.

CMFCPropertyGridProperty::CreateInPlaceEdit

Wywoływana przez platformę w celu utworzenia kontrolki edytowalnej dla właściwości.

virtual CWnd* CreateInPlaceEdit(
    CRect rectEdit,
    BOOL& bDefaultFormat);

Parametry

rectEdit
[in] Prostokąt ograniczenia kontrolki edytowalnej.

bDefaultFormat
[in] TRUE aby użyć domyślnego formatu właściwości, aby ustawić tekst kontrolki edytowalnej; w przeciwnym razie, FALSE.

Wartość zwracana

Wskaźnik do kontrolki edytowalnej, jeśli ta metoda powiedzie się; w przeciwnym razie, NULL.

Uwagi

Ta metoda używa wartości parametrów varValue, , lpszEditMasklpszEditTemplatei lpszValidChars określonych w konstruktorze CMFCPropertyGridProperty klasy. Domyślnie ta metoda obsługuje typy wariantów varValue . VT_BSTRObejmuje to , , , VT_UI1VT_I2VT_INTVT_R8VT_R4VT_I4VT_UI2VT_UINTVT_UI4i .VT_BOOL

Ta metoda tworzy kontrolkę CMFCMaskedEdit , jeśli określono co najmniej jeden z parametrów lpszEditMask, lpszEditTemplatelub lpszValidChars ; w przeciwnym razie tworzy kontrolkę CEdit .

CMFCPropertyGridProperty::CreateSpinControl

Wywoływana przez strukturę w celu utworzenia edytowalnej kontrolki przycisku pokrętła.

virtual CSpinButtonCtrl* CreateSpinControl(CRect rectSpin);

Parametry

rectSpin
[in] Prostokąt, który definiuje, gdzie jest tworzona edytowalna kontrolka przycisku pokrętła.

Wartość zwracana

Wskaźnik do nowego CMFCSpinButtonCtrl obiektu rzutowania jako wskaźnik do CSpinButtonCtrl obiektu.

Uwagi

Wywołaj metodę , CMFCPropertyGridProperty::EnableSpinControl aby wyświetlić edytowalną kontrolkę przycisku pokrętła w prawej krawędzi właściwości.

CMFCPropertyGridProperty::Enable

Włącza lub wyłącza właściwość.

void Enable(BOOL bEnable=TRUE);

Parametry

bEnable
[in] TRUE aby włączyć właściwość; FALSE aby wyłączyć właściwość . Wyłączone właściwości nie reagują na dane wejściowe myszy ani klawiatury. Wartość domyślna to TRUE.

CMFCPropertyGridProperty::EnableSpinControl

Włącza lub wyłącza kontrolkę przycisku spin, która jest używana do modyfikowania wartości właściwości.

void EnableSpinControl(
    BOOL bEnable=TRUE,
    int nMin=0,
    int nMax=0);

Parametry

bEnable
[in] TRUE aby włączyć kontrolkę przycisku pokrętła; FALSE aby wyłączyć kontrolkę przycisku pokrętła. Wartość domyślna to TRUE.

nMin
[in] Minimalna wartość kontrolki przycisku pokrętła. Wartość domyślna to 0.

nMax
[in] Maksymalna wartość kontrolki przycisku pokrętła. Wartość domyślna to 0.

Uwagi

Platforma automatycznie tworzy kontrolkę przycisku pokrętła, gdy właściwość ma zostać edytowana.

Typ właściwości określony przez varValue parametr konstruktora musi być obsługiwanym typem wariantu CMFCPropertyGridProperty::CMFCPropertyGridProperty . W przeciwnym razie ta metoda jest asercyjna w trybie debugowania. Obsługiwane typy obejmują VT_INT, , VT_UINT, VT_I2VT_I4, , VT_UI2i VT_UI4.

CMFCPropertyGridProperty::Expand

Rozwija lub zwija właściwość zawierającą podwłaściwości.

void Expand(BOOL bExpand=TRUE);

Parametry

bExpand
[in] TRUE aby rozwinąć właściwość; FALSE aby zwinąć właściwość . Wartość domyślna to TRUE.

CMFCPropertyGridProperty::FormatProperty

Formatuje tekstową reprezentację wartości właściwości.

virtual CString FormatProperty();

Wartość zwracana

Tekstowa reprezentacja wartości właściwości.

Uwagi

Ta metoda jest wywoływana przez strukturę przed wyświetleniem wartości właściwości.

CMFCPropertyGridProperty::GetData

DWORD Pobiera wartość skojarzona z właściwością.

DWORD_PTR GetData() const;

Wartość zwracana

DWORD Wartość.

Uwagi

Zwracane dane są wartością specyficzną dla aplikacji, taką jak liczba lub wskaźnik do innych danych. Określ wartość danych podczas konstruowania właściwości lub wywoływania CMFCPropertyGridProperty::SetData metody.

CMFCPropertyGridProperty::GetDescription

Pobiera opis właściwości.

const CString& GetDescription() const;

Wartość zwracana

Ciąg tekstowy zawierający opis właściwości.

Uwagi

Kontrolka lista właściwości używa również tej metody do wyświetlania opisu właściwości.

CMFCPropertyGridProperty::GetExpandedSubItems

Pobiera liczbę rozszerzonych subitemów.

int GetExpandedSubItems(BOOL bIncludeHidden=TRUE) const;

Parametry

bIncludeHidden
[in] TRUE do uwzględnienia ukrytych subitemów w liczbie; w przeciwnym razie, FALSE. Wartość domyślna to TRUE.

Wartość zwracana

Liczba rozszerzonych subitemów.

CMFCPropertyGridProperty::GetHierarchyLevel

Pobiera indeks zerowy poziomu hierarchii właściwości.

int GetHierarchyLevel() const;

Wartość zwracana

Poziom hierarchiczny właściwości.

CMFCPropertyGridProperty::GetName

Pobiera nazwę właściwości.

LPCTSTR GetName() const;

Wartość zwracana

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

CMFCPropertyGridProperty::GetNameTooltip

Wywoływana przez platformę w celu wyświetlenia nazwy właściwości w etykietce narzędzia.

virtual CString GetNameTooltip();

Wartość zwracana

Ciąg zawierający nazwę właściwości. Domyślnie wartość zwracana jest pustym ciągiem.

CMFCPropertyGridProperty::GetOption

Pobiera tekst opcji określonej przez indeks.

LPCTSTR GetOption(int nIndex) const;

Parametry

nIndex
Indeks zerowy elementu listy właściwości (opcja) do pobrania.

Wartość zwracana

Wskaźnik do ciągu zawierającego tekst opcji.

CMFCPropertyGridProperty::GetOptionCount

Pobiera liczbę opcji należących do właściwości.

int GetOptionCount() const;

Wartość zwracana

Liczba elementów listy właściwości (opcji), które znajdują się w kontrolce właściwości.

Uwagi

Wywołaj metodę , CMFCPropertyGridProperty::AddOption aby dodać elementy do listy właściwości. Wywołaj metodę , CMFCPropertyGridProperty::RemoveAllOptions aby usunąć wszystkie elementy.

CMFCPropertyGridProperty::GetOriginalValue

Pobiera początkową wartość bieżącej właściwości.

const COleVariant& GetOriginalValue() const;

Wartość zwracana

Oryginalna wartość bieżącej właściwości.

Uwagi

Użyj tej metody, aby cofnąć efekt operacji edycji, która zmienia wartość bieżącej właściwości.

Oryginalna wartość bieżącej właściwości jest ustawiana przez CMFCPropertyGridProperty::CMFCPropertyGridProperty konstruktora, modyfikowana przez CMFCPropertyGridProperty::SetOriginalValue metodę i resetowana przez metodę CMFCPropertyGridProperty::ResetOriginalValue .

CMFCPropertyGridProperty::GetParent

Pobiera wskaźnik do właściwości nadrzędnej.

CMFCPropertyGridProperty* GetParent() const;

Wartość zwracana

Wskaźnik do obiektu właściwości nadrzędnej lub NULL dla właściwości najwyższego poziomu.

CMFCPropertyGridProperty::GetRect

Pobiera prostokąt ograniczenia właściwości.

CRect GetRect() const;

Wartość zwracana

CRect Obiekt opisujący prostokąt ograniczenia.

CMFCPropertyGridProperty::GetSubItem

Pobiera właściwość podrzędną zidentyfikowaną przez indeks oparty na zerze.

CMFCPropertyGridProperty* GetSubItem(int nIndex) const;

Parametry

nIndex
[in] Indeks zerowy właściwości do pobrania. Ten parametr jest nieprawidłowy, jeśli jest mniejszy niż zero lub większy lub równy liczbie właściwości podrzędnych.

Wartość zwracana

Wskaźnik do obiektu właściwości, który jest elementem podrzędnym tej właściwości.

— lub —

W trybie detalicznymnIndex, NULL jeśli parametr jest nieprawidłowy. W trybie debugowania ta metoda jest asercyjna.

CMFCPropertyGridProperty::GetSubItemsCount

Pobiera liczbę elementów podrzędnych.

int GetSubItemsCount() const;

Wartość zwracana

Liczba elementów podrzędnych.

CMFCPropertyGridProperty::GetValue

Pobiera wartość właściwości.

virtual const _variant_t& GetValue() const;

Wartość zwracana

Wariant zawierający wartość właściwości.

CMFCPropertyGridProperty::GetValueTooltip

Wywoływana przez platformę w celu pobrania tekstowej reprezentacji wartości właściwości, która jest następnie wyświetlana w etykietce narzędzia.

virtual CString GetValueTooltip();

Wartość zwracana

CString Obiekt zawierający tekstową reprezentację wartości właściwości. Domyślnie ta wartość jest pustym ciągiem.

CMFCPropertyGridProperty::HasButton

Wskazuje, czy właściwość zawiera przycisk.

virtual BOOL HasButton() const;

Wartość zwracana

TRUE jeśli właściwość zawiera przycisk (lub listę właściwości); w przeciwnym razie, FALSE.

CMFCPropertyGridProperty::HitTest

Wskazuje obiekt właściwości odpowiadający elementowi listy właściwości, który odpowiada punktowi.

CMFCPropertyGridProperty* HitTest(
    CPoint point,
    CMFCPropertyGridProperty::ClickArea* pnArea=NULL);

CMFCPropertyGridProperty* HitTest(
    CPoint pt,
    CMFCPropertyGridProperty::ClickArea* pnArea=NULL,
    BOOL bPropsOnly=FALSE) const;

Parametry

point
[in] Punkt do przetestowania we współrzędnych klienta. Ten parametr jest zazwyczaj bieżącą lokalizacją wskaźnika myszy.

pt
[in] Punkt do przetestowania we współrzędnych klienta.

pnArea
[out] Gdy ta metoda zwraca wartość, wskazuje obszar, który zawiera określony punkt. Aby uzyskać więcej informacji zobacz uwagi. Wartość domyślna to NULL.

bPropsOnly
[in] TRUE do testowania dowolnego obszaru w kontrolce właściwości; FALSE aby przetestować tylko obszar opisu. Wartość domyślna to FALSE.

Wartość zwracana

Wskaźnik do obiektu właściwości lub NULL.

Uwagi

Domyślnie ta metoda testuje subitemy właściwości, jeśli określony punkt nie zostanie znaleziony w żadnym z elementów właściwości.

W poniższej tabeli wymieniono wartości, które można zwrócić do parametru pnArea .

Obszar opis
ClickArea::ClickExpandBox Kontrolka rozwiń pole, która jest wyznaczona przez znak plus (+).
ClickArea::ClickName Nazwa właściwości.
ClickArea::ClickValue Wartość właściwości.

CMFCPropertyGridProperty::Init

Wywoływana przez strukturę w celu zainicjowania obiektu właściwości.

void Init();

CMFCPropertyGridProperty::IsAllowEdit

Wskazuje, czy właściwość jest edytowalna.

BOOL IsAllowEdit() const;

Wartość zwracana

TRUE jeśli właściwość jest edytowalna; w przeciwnym razie FALSE.

CMFCPropertyGridProperty::IsEnabled

Wskazuje, czy właściwość jest włączona, czy wyłączona.

BOOL IsEnabled() const;

Wartość zwracana

TRUE jeśli właściwość jest włączona; FALSE jeśli właściwość jest wyłączona.

Uwagi

Informuje, czy właściwość jest włączona, czy wyłączona.

CMFCPropertyGridProperty::IsExpanded

Wskazuje, czy właściwość jest rozwinięta, czy zwinięta.

BOOL IsExpanded() const;

Wartość zwracana

TRUE jeśli właściwość jest rozwinięta; FALSE jeśli właściwość jest zwinięta.

CMFCPropertyGridProperty::IsGroup

Wskazuje, czy bieżąca właściwość reprezentuje grupę.

BOOL IsGroup() const;

Wartość zwracana

TRUE jeśli bieżący obiekt właściwości reprezentuje grupę; FALSE jeśli właściwość reprezentuje wartość.

Uwagi

Grupa jest kolekcją powiązanych właściwości w kontrolce siatki właściwości. Jeśli kontrolka jest wyświetlana hierarchicznie, nazwa grupy jest wyświetlana jako tytuł kategorii w wierszu powyżej grupy.

CMFCPropertyGridProperty::IsInPlaceEditing

Wskazuje, czy bieżąca właściwość jest edytowalna.

BOOL IsInPlaceEditing() const;

Wartość zwracana

TRUE jeśli bieżąca właściwość jest edytowalna; w przeciwnym razie, FALSE.

CMFCPropertyGridProperty::IsModified

Wskazuje, czy bieżąca właściwość jest modyfikowana.

BOOL IsModified() const;

Wartość zwracana

TRUE jeśli właściwość jest modyfikowana; w przeciwnym razie, FALSE.

CMFCPropertyGridProperty::IsParentExpanded

Wskazuje, czy częścią nadrzędną bieżącej właściwości są rozwinięte.

BOOL IsParentExpanded() const;

Wartość zwracana

TRUE jeśli wszystkie rodzice bieżącej właściwości są rozwinięte; FALSE jeśli właściwości nadrzędne są zwinięte.

CMFCPropertyGridProperty::IsSelected

Wskazuje, czy wybrano bieżącą właściwość.

virtual BOOL IsSelected() const;

Wartość zwracana

TRUE jeśli wybrano bieżącą właściwość; w przeciwnym razie, FALSE.

CMFCPropertyGridProperty::IsSubItem

Wskazuje, czy określona właściwość jest subitem bieżącej właściwości.

BOOL IsSubItem(CMFCPropertyGridProperty* pProp) const;

Parametry

pProp
[in] Wskaźnik do właściwości.

Wartość zwracana

TRUE jeśli określona właściwość jest subitem bieżącej właściwości; w przeciwnym razie, FALSE.

CMFCPropertyGridProperty::IsValueChanged

Wskazuje, czy wartość bieżącej właściwości uległa zmianie.

virtual BOOL IsValueChanged() const;

Wartość zwracana

TRUE jeśli wartość bieżącej właściwości uległa zmianie; w przeciwnym razie, FALSE.

CMFCPropertyGridProperty::IsVisible

Wskazuje, czy bieżąca właściwość jest widoczna.

BOOL IsVisible() const;

Wartość zwracana

TRUE jeśli bieżąca właściwość jest widoczna; Inaczej; FALSE.

CMFCPropertyGridProperty::m_strFormatDouble

Przechowuje ciąg formatu dla wartości typu podwójnej.

static CString m_strFormatDouble;

CMFCPropertyGridProperty::m_strFormatFloat

Przechowuje ciąg formatu dla wartości typu float.

static CString m_strFormatFloat;

CMFCPropertyGridProperty::m_strFormatLong

Przechowuje ciąg formatu dla wartości typu long.

static CString m_strFormatLong;

CMFCPropertyGridProperty::m_strFormatShort

Przechowuje ciąg formatu dla wartości typu krótkiego.

static CString m_strFormatShort;

CMFCPropertyGridProperty::OnClickButton

Wywoływana przez platformę, gdy użytkownik wybierze przycisk zawarty we właściwości.

virtual void OnClickButton(CPoint point);

Parametry

point
[in] Punkt we współrzędnych klienta.

Uwagi

Domyślnie ta metoda nic nie robi.

CMFCPropertyGridProperty::OnClickName

Wywoływana przez kontrolkę listy właściwości nadrzędnych, gdy użytkownik wybierze pole nazwy właściwości.

virtual void OnClickName(CPoint C);

Parametry

C
[in] Punkt we współrzędnych klienta.

Uwagi

Domyślnie ta metoda nic nie robi.

CMFCPropertyGridProperty::OnClickValue

Wywoływana przez kontrolkę listy właściwości nadrzędnych, gdy użytkownik wybierze pole wartości właściwości.

virtual BOOL OnClickValue(
    UINT uiMsg,
    CPoint point);

Parametry

uiMsg
[in] Komunikat myszy.

point
[in] Punkt we współrzędnych klienta.

Wartość zwracana

TRUE jeśli określony komunikat myszy jest przetwarzany przez tę metodę; w przeciwnym razie, FALSE.

Uwagi

Domyślnie ta metoda zwraca FALSE wartość , jeśli bieżąca właściwość nie jest edytowalna. W przeciwnym razie kontrolka edycji lub pokrętła skojarzona z tą właściwością przetwarza określony komunikat myszy, a następnie ta metoda zwraca wartość TRUE.

CMFCPropertyGridProperty::OnCloseCombo

Wywoływana przez platformę, gdy pole kombi zawarte we właściwości jest zamknięte.

virtual void OnCloseCombo();

CMFCPropertyGridProperty::OnCtlColor

Wywoływana przez strukturę, gdy musi pobrać szczotkę, aby wypełnić kolor tła właściwości.

virtual HBRUSH OnCtlColor(
    CDC* pDC,
    UINT nCtlColor);

Parametry

pDC
[in] Wskaźnik do kontekstu urządzenia.

nCtlColor
[in] (Ten parametr nie jest używany).

Wartość zwracana

Uchwyt do pędzla, jeśli ta metoda zakończy się pomyślnie; w przeciwnym razie, NULL.

CMFCPropertyGridProperty::OnDblClk

Wywoływana przez platformę, gdy użytkownik dwukrotnie kliknie właściwość.

virtual BOOL OnDblClk(CPoint point);

Parametry

point
[in] Punkt we współrzędnych klienta.

Wartość zwracana

TRUE jeśli ta metoda zakończy się pomyślnie; w przeciwnym razie, FALSE.

Uwagi

Domyślnie ta metoda wybiera następny element właściwości w kontrolce listy właściwości.

CMFCPropertyGridProperty::OnDestroyWindow

Wywoływana przez platformę, gdy właściwość zostanie zniszczona lub po zakończeniu edycji.

virtual void OnDestroyWindow();

CMFCPropertyGridProperty::OnDrawButton

Wywoływana przez strukturę w celu narysowania przycisku, który znajduje się we właściwości.

virtual void OnDrawButton(
    CDC* pDC,
    CRect rectButton);

Parametry

pDC
[in] Wskaźnik do kontekstu urządzenia.

rectButton
[in] Prostokąt ograniczenia, który określa, gdzie narysować przycisk.

CMFCPropertyGridProperty::OnDrawDescription

Wywoływana przez strukturę w celu narysowania opisu właściwości.

virtual void OnDrawDescription(
    CDC* pDC,
    CRect rect);

Parametry

pDC
[in] Wskaźnik do kontekstu urządzenia.

rect
[in] Prostokąt ograniczenia, który określa, gdzie narysować opis właściwości.

Uwagi

Domyślnie ta metoda rysuje nazwę właściwości i opis czcionki używanej przez kontrolkę listy właściwości nadrzędnych. Opis właściwości jest rysowany w regularnym stylu, a nazwa właściwości jest rysowana w stylu pogrubienia.

CMFCPropertyGridProperty::OnDrawExpandBox

Wywoływana przez strukturę w celu rysowania kontrolki rozwiń pole w pobliżu właściwości, która zawiera właściwości podrzędne.

virtual void OnDrawExpandBox(
    CDC* pDC,
    CRect rectExpand);

Parametry

pDC
[in] Wskaźnik do kontekstu urządzenia.

rectExpand
[in] Prostokąt ograniczenia, który określa, gdzie narysować kontrolkę rozwiń pole.

Uwagi

Wybierz kontrolkę rozwiń pole, aby rozwinąć lub zwinąć listę podwłaściwości. Kontrolka pola rozwijania jest oznaczona kwadratem zawierającym znak plus (+) lub minus (-). Znak plus wskazuje, że właściwość można rozszerzyć, aby wyświetlić listę podwłaściwości. Znak minus wskazuje, że listę można zwinąć, aby pokazać tylko właściwość.

CMFCPropertyGridProperty::OnDrawName

Wywoływana przez strukturę w celu wyświetlenia nazwy właściwości.

virtual void OnDrawName(
    CDC* pDC,
    CRect rect);

Parametry

pDC
[in] Wskaźnik do kontekstu urządzenia.

rect
[in] Prostokąt ograniczenia, który określa, gdzie narysować nazwę właściwości.

CMFCPropertyGridProperty::OnDrawValue

Wywoływana przez platformę w celu wyświetlenia wartości właściwości.

virtual void OnDrawValue(
    CDC* pDC,
    CRect rect);

Parametry

pDC
[in] Wskaźnik do kontekstu urządzenia.

rect
[in] Prostokąt ograniczenia określający, gdzie narysować wartość właściwości.

CMFCPropertyGridProperty::OnEdit

Wywoływana przez platformę, gdy użytkownik ma zmodyfikować wartość właściwości.

virtual BOOL OnEdit(LPPOINT lptClick);

Parametry

lptClick
[in] (Ten parametr nie jest używany). Wskaźnik do punktu we współrzędnych klienta.

Wartość zwracana

TRUE jeśli operacja edycji zostanie pomyślnie uruchomiona; w przeciwnym razie, FALSE.

Uwagi

Ta funkcja jest wywoływana przez strukturę, gdy użytkownik ma zmodyfikować wartość właściwości. Domyślnie ta metoda uruchamia odpowiedni edytor dla kontrolki pola kombi lub kontrolki spin.

CMFCPropertyGridProperty::OnEndEdit

Wywoływana przez platformę po zakończeniu modyfikowania wartości właściwości przez użytkownika.

virtual BOOL OnEndEdit();

Wartość zwracana

Ta metoda zawsze zwraca wartość TRUE.

Uwagi

Domyślnie ta metoda niszczy bieżącą kontrolkę edycji, a następnie zwraca wartość TRUE.

CMFCPropertyGridProperty::OnKillFocus

Wywoływana przez platformę, gdy właściwość traci fokus wejściowy.

virtual BOOL OnKillFocus(CWnd*);

Parametry

CWnd
[in] (Nieużytne). Wskaźnik do okna.

Wartość zwracana

Ta metoda zawsze zwraca wartość TRUE.

Uwagi

Domyślnie ta metoda nic nie robi, a następnie zwraca wartość TRUE. Jeśli zastąpisz tę metodę, zwróć TRUE , czy platforma może zakończyć operację edycji, gdy właściwość utraci fokus wejściowy.

CMFCPropertyGridProperty::OnKillSelection

virtual void OnKillSelection(CMFCPropertyGridProperty*);

Parametry

[in] CMFCPropertyGridProperty*\

Uwagi

Domyślnie ta metoda nic nie robi.

CMFCPropertyGridProperty::OnPosSizeChanged

virtual void OnPosSizeChanged(CRect);

Parametry

[in] CRect\

Uwagi

Domyślnie ta metoda nic nie robi.

CMFCPropertyGridProperty::OnRClickName

Wywoływana przez platformę, gdy użytkownik wybierze prawy przycisk myszy w obszarze nazwy właściwości.

virtual void OnRClickName(CPoint C);

Parametry

C
[in] Punkt we współrzędnych klienta.

Uwagi

Domyślnie ta metoda nic nie robi.

CMFCPropertyGridProperty::OnRClickValue

Wywoływana przez platformę, gdy użytkownik wybierze prawy przycisk myszy w obszarze wartości właściwości.

virtual void OnRClickValue(
    CPoint C,
    BOOL B);

Parametry

C
[in] Punkt we współrzędnych klienta.

B
[in] Wartość logiczna.

Uwagi

Domyślnie ta metoda nic nie robi, a B parametr nie ma wstępnie zdefiniowanego celu.

CMFCPropertyGridProperty::OnSelectCombo

Wywoływana przez platformę, gdy użytkownik wybiera element z edytowalnego pola kombi.

virtual void OnSelectCombo();

Uwagi

Domyślnie ta metoda używa tekstu wybranego elementu do zaktualizowania wartości właściwości.

CMFCPropertyGridProperty::OnSetCursor

Wywoływana przez strukturę, gdy wskaźnik myszy przechodzi do elementu właściwości.

virtual BOOL OnSetCursor() const;

Wartość zwracana

TRUE jeśli bieżąca właściwość jest typem wariantu lub listą wartości, a ta metoda pomyślnie ładuje wskaźnik wstawiania (I-beam) kursor myszy; w przeciwnym razie, FALSE.

Uwagi

Ta metoda obsługuje następujące typy wariantów: VT_INT, , VT_I2, VT_UINTVT_UI4VT_I4VT_UI2VT_R4VT_UI1VT_R8i .VT_BSTR

CMFCPropertyGridProperty::OnSetSelection

virtual void OnSetSelection CMFCPropertyGridProperty*);

Parametry

[in] CMFCPropertyGridProperty*\

Uwagi

Domyślnie ta metoda nic nie robi.

CMFCPropertyGridProperty::OnUpdateValue

Wywoływana przez strukturę, gdy wartość właściwości edytowalnej uległa zmianie.

virtual BOOL OnUpdateValue();

Wartość zwracana

TRUE jeśli ta metoda zakończy się pomyślnie; w przeciwnym razie, FALSE.

CMFCPropertyGridProperty::PushChar

Wywoływana z kontrolki listy właściwości, gdy właściwość jest zaznaczona, a użytkownik wprowadza nowy znak.

virtual BOOL PushChar(UINT nChar);

Parametry

nChar
[in] Znak.

Wartość zwracana

TRUE jeśli operacja edycji jest kontynuowana; w przeciwnym razie, FALSE.

Uwagi

Ta metoda obsługuje właściwość, która jest listą wartości lub jednym z następujących typów wariantów: VT_INT, VT_UINTVT_UI1VT_I4VT_I2VT_UI4VT_R4VT_UI2VT_R8i .VT_BSTR

CMFCPropertyGridProperty::Redraw

Ponownie rysuje właściwość .

void Redraw();

CMFCPropertyGridProperty::RemoveAllOptions

Usuwa wszystkie opcje (elementy) z właściwości.

void RemoveAllOptions();

Uwagi

Opcje są również nazywane elementami listy kontrolki listy właściwości.

CMFCPropertyGridProperty::RemoveSubItem

Usuwa określony element podrzędny.

BOOL RemoveSubItem(
    CMFCPropertyGridProperty*& pProp,
    BOOL bDelete=TRUE);

Parametry

pProp
[in] Wskaźnik do subitem właściwości.

bDelete
[in] TRUE aby usunąć obiekt właściwości określony przez pProp parametr ; w przeciwnym razie FALSE. Wartość domyślna to TRUE.

Wartość zwracana

Uwagi

Określ FALSE parametr , bDelete jeśli zamierzasz przenieść określony subitem; oznacza to, usuń poditem, a następnie dodaj go gdzie indziej.

CMFCPropertyGridProperty::ResetOriginalValue

Przywraca oryginalną wartość edytowanej właściwości.

virtual void ResetOriginalValue();

CMFCPropertyGridProperty::SetData

DWORD Kojarzy wartość z właściwością.

void SetData(DWORD_PTR dwData);

Parametry

dwData
[in] Wartość 32-bitowa specyficzna dla aplikacji, taka jak liczba całkowita lub wskaźnik do innych danych.

Uwagi

CMFCPropertyGridProperty::GetData Użyj metody , aby pobrać DWORD wartość. Użyj metody , CMFCPropertyGridCtrl::FindItemByData aby zlokalizować element listy właściwości skojarzony z określoną DWORD wartością.

CMFCPropertyGridProperty::SetDescription

Określa tekst opisujący bieżącą właściwość.

void SetDescription(const CString& strDescr);

Parametry

strDescr
[in] Tekst opisujący bieżącą właściwość.

CMFCPropertyGridProperty::SetName

Ustawia nazwę właściwości.

void SetName(
    LPCTSTR lpszName,
    BOOL bRedraw=TRUE);

Parametry

lpszName
[in] Nazwa właściwości.

bRedraw
[in] TRUE aby od razu ponownie wyrysować właściwość; w przeciwnym razie, FALSE. Wartość domyślna to TRUE.

CMFCPropertyGridProperty::SetOriginalValue

Ustawia oryginalną wartość właściwości edytowalnej.

virtual void SetOriginalValue(const COleVariant& varValue);

Parametry

varValue
[in] Wartość.

Uwagi

CMFCPropertyGridProperty::ResetOriginalValue Użyj metody , aby zresetować oryginalną wartość edytowanej właściwości.

CMFCPropertyGridProperty::SetValue

Ustawia wartość właściwości siatki właściwości.

virtual void SetValue(const _variant_t& varValue);

Parametry

varValue
[in] Odwołanie do wartości, na która ma być ustawiona właściwość .

Przykład: SetValue

void SetPropBarValue(UINT propId, const DWORD& barPropDwordValue)
{
  auto property = propertiesGridCtrlList.FindItemByData(propId);
  if (property != nullptr)
  {
    property->SetValue(static_cast<_variant_t >(barPropDwordValue == 1)); // set value to true or false depending on dword value
  }
}

CMFCPropertyGridProperty::Show

Pokazuje lub ukrywa właściwość.

void Show(
    BOOL bShow=TRUE,
    BOOL bAdjustLayout=TRUE);

Parametry

bShow
[in] TRUE aby wyświetlić bieżącą właściwość i jej podwitami; FALSE aby ukryć bieżącą właściwość i jej podzdziały. Wartość domyślna to TRUE.

bAdjustLayout
[in] TRUE aby ponownie obliczyć, jak narysować etykietę i wartość właściwości, a następnie narysować właściwość; FALSE aby użyć istniejących obliczeń, aby narysować właściwość. Wartość domyślna to TRUE.

Zobacz też

Wykres hierarchii
Klasy
Klasa CMFCPropertyGridCtrl