CMFCRibbonBaseElement クラス
このCMFCRibbonBaseElementクラスは、リボン バーに追加できるすべての要素の基本クラスです。 リボン要素とは、リボン ボタン、リボン チェック ボックス、リボン コンボ ボックスなどです。
構文
class CMFCRibbonBaseElement : public CObject
メンバー
パブリック コンストラクター
| 名前 | 説明 |
|---|---|
CMFCRibbonBaseElement |
CMFCRibbonBaseElement オブジェクトを構築します。 |
パブリック メソッド
保護メソッド
| 名前 | 説明 |
|---|---|
| CMFCRibbonBaseElement::OnProcessKey | ユーザーがショートカット キーを押したときにフレームワークによって呼び出されます。 |
| CMFCRibbonBaseElement::OnSetFocus | リボン要素が入力フォーカスを受け取るか失ったときにフレームワークによって呼び出されます。 |
解説
このクラスはCMFCRibbonBaseElement、コマンド ID、テキスト ラベル、ヒント テキスト、要素の説明、状態 (フォーカス、強調表示、押された、無効、チェック、またはドロップダウンが可能) を含むすべてのリボン要素に共通するプロパティを定義します。
リボン要素のイメージ サイズは、メンバーによって RibbonImageType 定義されます。次のいずれかの値を指定できます。
RibbonImageLargeRibbonImageSmall
サイズに応じて、リボン要素には小さい画像または大きな画像が表示されます。
例
CMFCRibbonBaseElement クラスのさまざまなメソッドの使用方法を次の例に示します。 この例では、クラスからCMFCRibbonStatusBarオブジェクトをCMFCRibbonBaseElement取得する方法、リボン要素の説明を設定する方法、テキストを設定する方法、キーヒントを設定する方法、リボン要素のヒント テキストを設定する方法を示します。 このコード スニペットは、「 クライアント サンプルの描画」の一部です。
// CMFCRibbonStatusBar m_wndStatusBar
CMFCRibbonBaseElement *pPane = m_wndStatusBar.FindByID(nID);
pPane->SetDescription(_T("a pane"));
// CString strText
pPane->SetText(strText);
pPane->SetKeys(_T("p"));
pPane->SetToolTipText(_T("this is a pane"));
継承階層
必要条件
ヘッダー: afxbaseribbonelement.h
CMFCRibbonBaseElement::AddToKeyList
リボン要素のキーヒントをキーヒントの配列に追加します。
virtual void AddToKeyList(
CArray<CMFCRibbonKeyTip*, CMFCRibbonKeyTip*>& arElems);
パラメーター
arElems
[in]キーヒントの CArray への参照。
解説
リボンのキーヒント機能が有効になっている場合、ユーザーが Alt キーまたは F10 キーを押すと、フレームワークにリボン キーヒントが表示されます。
CMFCRibbonBaseElement::AddToListBox
指定したリボン コマンドリストボックスにリボン要素を追加します。
virtual int AddToListBox(
CMFCRibbonCommandsListBox* pWndListBox,
BOOL bDeep);
パラメーター
pWndListBox
[in]コマンド リスト ボックスへのポインター。
bDeep
[入力] このパラメーターは使用しません。
戻り値
追加されたリボン要素の 0 から始まるインデックス。
解説
フレームワークは、コマンド リスト ボックスにリボン要素を追加して、ユーザーがユーザー インターフェイスをカスタマイズできるようにします。
CMFCRibbonBaseElement::CanBeAddedToQuickAccessToolBar
リボン要素をクイック アクセス ツール バーに追加できるかどうかを示します。
virtual BOOL CanBeAddedToQuickAccessToolBar() const;
戻り値
要素を追加できる場合は TRUE。それ以外の場合は FAL Standard Edition。
解説
CMFCRibbonBaseElement::CanBeCompacted
リボン要素のサイズをコンパクトにできるかどうかを示します。
virtual BOOL CanBeCompacted() const;
戻り値
リボン要素のサイズをコンパクトにできる場合は TRUE。それ以外の場合は FAL Standard Edition。
解説
リボン要素のサイズは、コンパクト、中間、または大にすることができます。
CMFCRibbonBaseElement::CanBeStretched
リボン要素の高さをリボン行の高さまで垂直方向に上げることができるかどうかを示します。
virtual BOOL CanBeStretched();
戻り値
常に TRUE が返されます。
解説
既定では、このメソッドは常に TRUE を返します。 リボン要素の高さをリボン行の高さに垂直に増加できるかどうかを示すには、このメソッドをオーバーライドします。
CMFCRibbonBaseElement::CanBeStretchedHorizontally
リボン要素の幅を変更できるかどうかを示します。
virtual BOOL CanBeStretchedHorizontally();
戻り値
常に FAL Standard Edition を返します。
解説
既定では、このメソッドは常に FAL Standard Edition を返します。 リボン要素の幅を変更できるかどうかを示すには、このメソッドをオーバーライドします。
CMFCRibbonBaseElement::CleanUpSizes
リボン要素のディメンション設定をクリーンアップします。
virtual void CleanUpSizes();
解説
既定では、このメソッドは何も行いません。 リボン要素のディメンション設定をリセットするには、派生クラスでこのメソッドをオーバーライドします。
CMFCRibbonBaseElement::ClosePopupMenu
リボン要素のポップアップ メニューを閉じます。
virtual void ClosePopupMenu();
解説
CMFCRibbonBaseElement::CopyFrom
指定した CMFCRibbonBaseElement の状態を現在のオブジェクトにコピーします。
virtual void CopyFrom(const CMFCRibbonBaseElement& src);
パラメーター
src
[in]ソース CMFCRibbonBaseElement オブジェクト。
解説
CMFCRibbonBaseElement::D estroyCtrl
リボン要素を破棄します。
virtual void DestroyCtrl();
解説
既定では、このメソッドは何も行いません。 リボン要素を破棄するには、派生クラスでこのメソッドをオーバーライドします。
CMFCRibbonBaseElement::D rawImage
リボン要素のイメージを描画します。
virtual void DrawImage(
CDC* pDC,
RibbonImageType type,
CRect rectImage);
パラメーター
pDC
[in]デバイス コンテキストへのポインター。
type
[in]イメージの種類の列挙値。 使用可能な値の一覧については、「解説」セクションを参照してください。
rectImage
[in]画像の四角形。
解説
既定では、このメソッドは何も行いません。 リボン要素のイメージを描画するには、派生クラスでこのメソッドをオーバーライドします。
次の表に、型パラメーターに使用できる値を示します。
| Value | 説明 |
|---|---|
RibbonImageLarge |
大きな 32 x 32 ピクセルの画像サイズ。 |
RibbonImageSmall |
小さな 16 x 16 ピクセルの画像サイズ。 |
CMFCRibbonBaseElement::Find
現在のオブジェクトを指している場合は、指定したポインターを返します。
virtual CMFCRibbonBaseElement* Find(const CMFCRibbonBaseElement* pElement);
パラメーター
pElement
[in]リボン要素へのポインター。
戻り値
pElement が現在のオブジェクトを指している場合はリボン要素へのポインター。それ以外の場合は NULL。
解説
CMFCRibbonBaseElement::FindByData
指定したデータがリボン要素に含まれている場合は、リボン要素へのポインターを取得します。
virtual CMFCRibbonBaseElement* FindByData(DWORD_PTR dwData);
パラメーター
dwData
[in]リボン要素に関連付けられているデータ。
戻り値
指定したデータがリボン要素に含まれている場合は、リボン要素へのポインター。それ以外の場合は NULL。
解説
CMFCRibbonBaseElement::FindByID
指定したコマンド ID で要素が識別される場合は、リボン要素へのポインターを取得します。
virtual CMFCRibbonBaseElement* FindByID(UINT uiCmdID);
パラメーター
uiCmdID
[in]リボン要素のコマンド ID。
戻り値
指定したコマンド ID で要素が識別される場合は、リボン要素へのポインター。それ以外の場合は NULL。
解説
CMFCRibbonBaseElement::FindByOriginal
元のリボン要素が指定したリボン要素と一致する場合は、現在のリボン要素へのポインターを取得します。
virtual CMFCRibbonBaseElement* FindByOriginal(CMFCRibbonBaseElement* pOriginal);
パラメーター
pOriginal
[in]リボン要素へのポインター。
戻り値
元のリボン要素が指定したリボン要素と一致する場合のリボン要素へのポインター。それ以外の場合は NULL。
解説
別のコンテナーにコピーされたリボン要素は、元のリボン要素へのポインターを保持します。
CMFCRibbonBaseElement::GetCompactSize
リボン要素のコンパクト サイズを返します。
virtual CSize GetCompactSize(CDC* pDC);
パラメーター
pDC
[入力] デバイス コンテキストへのポインター。
戻り値
リボン要素のコンパクト サイズ。
Note
コンパクト サイズは、リボン要素が切り捨てられていることを意味します (小さな画像またはテキストのない画像が表示されます)。
CMFCRibbonBaseElement::GetData
リボン要素に関連付けられているユーザー定義データを取得します。
DWORD_PTR GetData() const;
戻り値
リボン要素に関連付けられているユーザー定義データ。
CMFCRibbonBaseElement::GetDescription
リボン要素の説明を返します。
virtual CString GetDescription() const;
戻り値
リボン要素の説明。 説明は、リボン要素が CMFCRibbonMainPanel クラスにある場合は、ステータス バーまたはツールヒント、またはメニュー ボタンの下に表示されます。
CMFCRibbonBaseElement::GetDroppedDown
ポップアップ メニューがドロップダウンされた場合に、リボン要素へのポインターを取得します。
virtual CMFCRibbonBaseElement* GetDroppedDown();
戻り値
ポップアップ メニューがドロップダウンされた場合のリボン要素へのポインター。それ以外の場合は NULL。
解説
CMFCRibbonBaseElement::GetElements
現在のリボン要素を指定した配列に追加します。
virtual void GetElements(
CArray<CMFCRibbonBaseElement*, CMFCRibbonBaseElement*>& arElements);
パラメーター
arElements
[入力、出力]リボン要素の配列。
解説
CMFCRibbonBaseElement::GetElementsByID
現在のリボン要素に指定したコマンド ID が含まれている場合は、指定した配列に現在のリボン要素を追加します。
virtual void GetElementsByID(
UINT uiCmdID,
CArray<CMFCRibbonBaseElement*, CMFCRibbonBaseElement*>& arElements);
パラメーター
uiCmdID
[in]リボン要素のコマンド ID。
arElements
[in]リボン要素の配列。
解説
CMFCRibbonBaseElement::GetHighlighted
リボン要素が強調表示されている場合は、その要素へのポインターを取得します。
virtual CMFCRibbonBaseElement* GetHighlighted();
戻り値
リボン要素が強調表示されている場合のポインター。それ以外の場合は NULL。
解説
CMFCRibbonBaseElement::GetID
リボン要素のコマンド ID を返します。
UINT GetID() const;
戻り値
リボン要素のコマンド ID。
CMFCRibbonBaseElement::GetImageSize
リボン要素のイメージ サイズを返します。
virtual CSize GetImageSize(RibbonImageType R) const;
戻り値
リボン要素のイメージ サイズ。
CMFCRibbonBaseElement::GetIntermediateSize
サイズが中間状態になっているリボン要素のサイズを返します。
virtual CSize GetIntermediateSize(CDC* pDC);
パラメーター
pDC
[入力] デバイス コンテキストへのポインター。
戻り値
中間状態のリボン要素のサイズ。
CMFCRibbonBaseElement::GetKeys
リボン要素に関連付けられているキーヒントを返します。
LPCTSTR GetKeys() const;
戻り値
リボン要素に関連付けられているキーヒント。
CMFCRibbonBaseElement::GetKeyTipRect
リボン要素のキーヒント境界四角形を取得します。
virtual CRect GetKeyTipRect(
CDC* pDC,
BOOL bIsMenu);
パラメーター
pDC
[in]デバイス コンテキストへのポインター。
bIsMenu
[in]リボン要素にポップアップ メニューが表示される場合は TRUE。それ以外の場合は FAL Standard Edition。
戻り値
常に 0 の値を持つ四角形を返します。
解説
キーヒント境界の四角形を返すには、派生クラスでこのメソッドをオーバーライドします。
CMFCRibbonBaseElement::GetKeyTipSize
キーヒント テキストのサイズを取得します。
virtual CSize GetKeyTipSize(CDC* pDC);
パラメーター
pDC
[in]デバイス コンテキストへのポインター。
戻り値
キーヒント テキストのサイズ。
解説
CMFCRibbonBaseElement::GetLocationInGroup
リボン グループ内のリボン要素の表示場所を示します。
RibbonElementLocation GetLocationInGroup() const;
戻り値
RibbonElementLocation列挙値。 次の表に、使用可能な値を示します。
| Value | 説明 |
|---|---|
RibbonElementNotInGroup |
リボン要素はリボン グループに含まれていません。 |
RibbonElementSingleInGroup |
リボン要素は、リボン グループ内の唯一の項目として表示されます。 |
RibbonElementFirstInGroup |
リボン要素は、リボン グループの左端に表示されます。 |
RibbonElementLastInGroup |
リボン要素は、リボン グループの右端に表示されます。 |
RibbonElementMiddleInGroup |
リボン要素は、リボン グループの両端には表示されません。 |
解説
リボン要素グループは、水平方向にのみ配置されます。
CMFCRibbonBaseElement::GetMenuKeys
リボン要素のメニュー キーヒントを返します。
LPCTSTR GetMenuKeys() const;
戻り値
リボン要素に関連付けられているメニュー キーヒント。
解説
呼び出されると、メニュー キーヒントにポップアップ メニューが表示されます。
CMFCRibbonBaseElement::GetNotifyID
リボン要素の通知コマンド ID を取得します。
virtual UINT GetNotifyID();
戻り値
通知コマンド ID。
解説
CMFCRibbonBaseElement::GetOriginal
元のリボン要素を取得します。
CMFCRibbonBaseElement* GetOriginal() const;
戻り値
元のリボン要素へのポインター。
解説
別のコンテナーにコピーされたリボン要素は、元のリボン要素へのポインターを保持します。
CMFCRibbonBaseElement::GetParentCategory
リボン要素のリボン カテゴリを取得します。
CMFCRibbonCategory* GetParentCategory() const;
戻り値
リボン カテゴリへのポインター。
解説
CMFCRibbonBaseElement::GetParentPanel
リボン要素を含むリボン パネルを取得します。
virtual CMFCRibbonPanel* GetParentPanel() const;
戻り値
リボン要素を含むリボン パネルへのポインター。
解説
CMFCRibbonBaseElement::GetParentRibbonBar
リボン要素の親リボン バーを取得します。
CMFCRibbonBar* GetParentRibbonBar() const;
戻り値
リボン要素の親リボン バーへのポインター。
解説
CMFCRibbonBaseElement::GetParentWnd
リボン要素の親ウィンドウを取得します。
virtual CWnd* GetParentWnd() const;
戻り値
メソッドが成功した場合のリボン要素の親ウィンドウへのポインター。それ以外の場合は NULL。
解説
リボン要素の親ウィンドウは、 CMFCRibbonBar クラス または CMFCRibbonPanelMenuBar です。
CMFCRibbonBaseElement::GetPressed
ユーザーが現在リボン要素を押している場合は、リボン要素へのポインターを取得します。
virtual CMFCRibbonBaseElement* GetPressed();
戻り値
ユーザーが現在リボン要素を押している場合のリボン要素へのポインター。それ以外の場合は NULL。
解説
CMFCRibbonBaseElement::GetQuickAccessToolBarID
クイック アクセス ツール バーにあるリボン要素のコマンド ID を取得します。
virtual UINT GetQuickAccessToolBarID() const;
戻り値
リボン要素がクイック アクセス ツール バーにある場合のコマンド ID。
解説
CMFCRibbonBaseElement::GetRect
リボン要素の外接する四角形を返します。
CRect GetRect() const;
戻り値
リボン要素の外接する四角形。 四角形の位置は、親リボン コントロールの座標内にあります。
CMFCRibbonBaseElement::GetRegularSize
リボン要素の標準サイズを返します。
virtual CSize GetRegularSize(CDC* pDC) = 0;
パラメーター
pDC
[入力] デバイス コンテキストへのポインター。
戻り値
リボン要素の通常のサイズ。
解説
Note
通常のサイズは、リボン要素の最大サイズです。
CMFCRibbonBaseElement::GetSize
リボン要素の現在のサイズを返します。
virtual CSize GetSize(CDC* pDC);
パラメーター
pDC
[入力] デバイス コンテキストへのポインター。
戻り値
リボン要素の現在のサイズ。
CMFCRibbonBaseElement::GetText
リボン要素に関連付けられているテキストを返します。
LPCTSTR GetText() const;
戻り値
リボン要素に関連付けられているテキスト。
CMFCRibbonBaseElement::GetToolTipText
リボン要素のツールヒント テキストを返します。
virtual CString GetToolTipText() const;
戻り値
リボン要素のツールヒント テキスト。
CMFCRibbonBaseElement::GetTopLevelRibbonBar
リボン要素の最上位レベルのリボン バーを取得します。
CMFCRibbonBar* GetTopLevelRibbonBar() const;
戻り値
メソッドが成功した場合にリボン要素の最上位レベルのリボン バーへのポインター。それ以外の場合は NULL。
解説
CMFCRibbonBaseElement::HasCompactMode
リボン要素に簡易モードがあるかどうかを指定します。
virtual BOOL HasCompactMode() const;
戻り値
リボン要素にコンパクト モードがある場合は TRUE。 それ以外の場合は FALSE。
解説
Note
コンパクト モードでは、要素は小さな画像のみを表示します。
CMFCRibbonBaseElement::HasIntermediateMode
リボン要素に中間モードがあるかどうかを指定します。
virtual BOOL HasIntermediateMode() const;
戻り値
リボン要素に中間モードがある場合は TRUE、それ以外の場合は FAL Standard Edition。 中間モードでは、要素は画像の右側に小さな画像とテキストを表示します。
解説
CMFCRibbonBaseElement::HasLargeMode
リボン要素に大モードがあるかどうかを指定します。
virtual BOOL HasLargeMode() const;
戻り値
リボン要素に大きなモードがある場合は TRUE。 それ以外の場合は FALSE。
解説
大モードでは、要素は親パネルの高さを完全に取得できます。
CMFCRibbonBaseElement::HasMenu
リボン要素にメニューがあるかどうかを示します。
virtual BOOL HasMenu() const;
戻り値
常に FAL Standard Edition を返します。
解説
既定では、このメソッドは常に FAL Standard Edition を返します。 リボン要素にメニューがあるかどうかを示すには、派生クラスでこのメソッドをオーバーライドします。
CMFCRibbonBaseElement::HitTest
指定したポイントがリボン要素内にある場合は、リボン要素へのポインターを取得します。
virtual CMFCRibbonBaseElement* HitTest(CPoint point);
パラメーター
point
[入力] このパラメーターは使用しません。
戻り値
リボン要素が存在する場合は、その要素へのポインター。それ以外の場合は FAL Standard Edition。
解説
既定では、このメソッドは常にリボン要素が存在する場合に有効なポインターを返します。 ポイントがリボン要素に存在するかどうかを示すには、このメソッドをオーバーライドします。
CMFCRibbonBaseElement::IsAlignByColumn
リボン要素が他のリボン要素と垂直方向に配置されているかどうかを示します。
virtual BOOL IsAlignByColumn() const;
戻り値
常に TRUE が返されます。
解説
既定では、このメソッドは常に TRUE を返します。 派生リボン要素が他のリボン要素と垂直方向に配置されているかどうかを示すには、派生クラスでこのメソッドをオーバーライドします。
CMFCRibbonBaseElement::IsAlwaysLargeImage
リボン要素のイメージ サイズが常に大きいかどうかを示します。
virtual BOOL IsAlwaysLargeImage() const;
戻り値
リボン要素のイメージ サイズが常に大きい場合は TRUE。それ以外の場合は FAL Standard Edition。
解説
大きな画像サイズは 32 x 32 ピクセルです。
CMFCRibbonBaseElement::IsAutoRepeatMode
リボン要素が自動繰り返しモードであるかどうかを示します。
virtual BOOL IsAutoRepeatMode(int& nDelay) const;
パラメーター
nDelay
[入力] このパラメーターは使用しません。
戻り値
常に FAL Standard Edition を返します。
解説
既定では、このメソッドは常に FAL Standard Edition を返します。 リボン要素が自動繰り返しモードであるかどうかを示すには、このメソッドをオーバーライドします。
自動繰り返しモードでは、リボン要素は、設定された間隔 (ミリ秒単位) で持続的なユーザー入力に応答します。
CMFCRibbonBaseElement::IsChecked
リボン要素をチェックするかどうかを指定します。
virtual BOOL IsChecked() const;
戻り値
リボン要素がチェックされている場合は TRUE、それ以外の場合は FAL Standard Edition。
CMFCRibbonBaseElement::IsCompactMode
リボン要素がコンパクト モードかどうかを指定します。
BOOL IsCompactMode() const;
戻り値
リボン要素がコンパクト モードの場合は TRUE。それ以外の場合は FAL Standard Edition。
CMFCRibbonBaseElement::IsDefaultMenuLook
リボン要素がポップアップ コマンドとして表示されるように設定されているかどうかを示します。
BOOL IsDefaultMenuLook() const;
戻り値
リボン要素がポップアップ コマンドとして表示されるように設定されている場合は TRUE。それ以外の場合は FAL Standard Edition。
解説
CMFCRibbonBaseElement::IsDisabled
リボン要素を無効にするかどうかを指定します。
virtual BOOL IsDisabled() const;
戻り値
リボン要素が無効な場合は TRUE。それ以外の場合は FAL Standard Edition。
CMFCRibbonBaseElement::IsDroppedDown
リボン要素にポップアップ メニューを表示し、ドロップ ダウンするかどうかを指定します。
virtual BOOL IsDroppedDown() const;
戻り値
リボン要素がドロップダウンされ、ポップアップ メニューが表示される場合は TRUE。それ以外の場合は FAL Standard Edition。
CMFCRibbonBaseElement::IsFocused
リボン要素にフォーカスがあるかどうかを指定します。
virtual BOOL IsFocused() const;
戻り値
リボン要素にフォーカスがある場合は TRUE。それ以外の場合は FAL Standard Edition。
CMFCRibbonBaseElement::IsGalleryIcon
リボン要素がリボン ギャラリーに含まれているかどうかを示します。
virtual BOOL IsGalleryIcon() const;
戻り値
常に FAL Standard Edition を返します。
解説
既定では、このメソッドは常に FAL Standard Edition を返します。 リボン要素がリボン ギャラリーに含まれているかどうかを示すには、派生クラスでこのメソッドをオーバーライドします。
CMFCRibbonBaseElement::IsHighlighted
リボン要素を強調表示するかどうかを指定します。
virtual BOOL IsHighlighted() const;
戻り値
リボン要素が強調表示されている場合は TRUE。それ以外の場合は FAL Standard Edition。
解説
CMFCRibbonBaseElement::IsIntermediateMode
リボン要素の現在のイメージが中間サイズかどうかを示します。
BOOL IsIntermediateMode() const;
戻り値
リボン要素の画像が中間サイズの場合は TRUE。それ以外の場合は FAL Standard Edition。
解説
中間画像サイズは 16 x 16 ピクセルです。
CMFCRibbonBaseElement::IsLargeMode
リボン要素の現在のイメージが大きいサイズかどうかを示します。
BOOL IsLargeMode() const;
戻り値
リボン要素の画像のサイズが大きい場合は TRUE。それ以外の場合は FAL Standard Edition。
解説
大きな画像サイズは 32 x 32 ピクセルです。
CMFCRibbonBaseElement::IsMenuMode
リボン要素がメニューに含まれているかどうかを示します。
BOOL IsMenuMode() const;
戻り値
リボン要素がメニューに含まれている場合は TRUE。それ以外の場合は FAL Standard Edition。
解説
CMFCRibbonBaseElement::IsPressed
ユーザーがリボン要素をクリックしたかどうかを示します。
virtual BOOL IsPressed() const;
戻り値
ユーザーがリボン要素をクリックした場合は TRUE。それ以外の場合は FAL Standard Edition。
CMFCRibbonBaseElement::IsQATMode
リボン要素がクイック アクセス ツール バーに含まれているかどうかを示します。
BOOL IsQATMode() const;
戻り値
リボン要素がクイック アクセス ツール バーに含まれている場合は TRUE。それ以外の場合は FAL Standard Edition。
解説
CMFCRibbonBaseElement::IsSeparator
リボン要素が表示区切り記号かどうかを示します。
virtual BOOL IsSeparator() const;
戻り値
リボン要素が表示区切り記号の場合は TRUE。それ以外の場合は FAL Standard Edition。
解説
CMFCRibbonBaseElement::IsShowGroupBorder
リボン要素が共通の罫線を表示するグループに含まれているかどうかを示します。
BOOL IsShowGroupBorder() const;
戻り値
リボン要素が共通の罫線を表示するグループに含まれている場合は TRUE。それ以外の場合は FAL Standard Edition。
解説
CMFCRibbonBaseElement::IsShowTooltipOnBottom
リボン要素の下にツールヒントが表示されるかどうかを示します。
virtual BOOL IsShowTooltipOnBottom() const;
戻り値
リボン要素の下にツールヒントが表示される場合は TRUE。FAL Standard Editionポインターの近くにツールヒントが表示される場合。
解説
CMFCRibbonBaseElement::IsTabStop
リボン要素をキーボードで選択できるかどうかを示します。
virtual BOOL IsTabStop() const;
戻り値
常に TRUE が返されます。
解説
既定では、このメソッドは常に TRUE を返します。 リボン要素をキーボードで選択できるかどうかを示すには、このメソッドをオーバーライドします。
CMFCRibbonBaseElement::IsTextAlwaysOnRight
リボン要素のテキストが右側に表示されるかどうかを示します。
BOOL IsTextAlwaysOnRight() const;
戻り値
リボン要素のテキストが右側に表示される場合は TRUE。それ以外の場合は FAL Standard Edition。
解説
CMFCRibbonBaseElement::IsVisible
リボン要素が現在表示されているかどうかを示します。
BOOL IsVisible() const;
戻り値
リボン要素が現在表示されている場合は TRUE。それ以外の場合は FAL Standard Edition。
解説
CMFCRibbonBaseElement::IsWholeRowHeight
リボン要素の表示高さが、リボン 要素を含むリボン パネルの表示高さと同じかどうかを示します。
virtual BOOL IsWholeRowHeight() const;
戻り値
常に FAL Standard Edition を返します。
解説
既定では、このメソッドは常に FAL Standard Edition を返します。 リボン要素の表示高さが、リボン 要素を含むリボン パネルの表示高さと同じかどうかを示すには、このメソッドをオーバーライドします。
CMFCRibbonBaseElement::NotifyCommand
リボン要素の親ウィンドウにコマンド通知を送信します。
BOOL NotifyCommand(BOOL bWithDelay = FALSE);
パラメーター
bWithDelay
[in]親ウィンドウのメッセージ キューにコマンド通知を追加する場合は TRUE。FAL Standard Editionメッセージを親ウィンドウに直ちに送信します。
戻り値
メッセージが送信された場合は TRUE。それ以外の場合は FAL Standard Edition。
解説
CMFCRibbonBaseElement::NotifyHighlightListItem
ユーザーがリスト内にあるリボン要素を強調表示したときに、リボン バーの親ウィンドウに通知します。
virtual void NotifyHighlightListItem(int nIndex);
パラメーター
Nindex
[in]リスト内のリボン要素のインデックス。
解説
CMFCRibbonBaseElement::OnAddToQAToolbar
指定したクイック アクセス ツール バーにリボン要素を追加します。
virtual BOOL OnAddToQAToolbar(CMFCRibbonQuickAccessToolBar& qat);
パラメーター
Qat
[in]クイック アクセス ツール バー。
戻り値
リボン要素がクイック アクセス ツール バーに追加されたことを示す TRUE を常に返します。
解説
CMFCRibbonBaseElement::OnAfterChangeRect
リボン要素のツールヒントを更新します。
virtual void OnAfterChangeRect(CDC* pDC);
パラメーター
pDC
[入力] このパラメーターは使用しません。
解説
既定では、このメソッドはリボン要素のヒントを更新します。 表示四角形が変更された後にリボン要素を更新するには、このメソッドをオーバーライドします。
CMFCRibbonBaseElement::OnAutoRepeat
持続的なユーザー入力に応じてリボン要素を更新します。
virtual BOOL OnAutoRepeat();
戻り値
常に FAL Standard Edition を返します。
解説
既定では、このメソッドは常に FAL Standard Edition を返します。 このメソッドをオーバーライドして、持続的なユーザー入力を処理します。
CMFCRibbonBaseElement::OnCalcTextSize
リボン要素のテキストのサイズを計算します。
virtual void OnCalcTextSize(CDC* pDC);
パラメーター
pDC
[入力] このパラメーターは使用しません。
解説
既定では、このメソッドは何も行いません。 リボン要素のテキストのサイズを計算するには、このメソッドをオーバーライドします。
CMFCRibbonBaseElement::OnChangeMenuHighlight
メニューにあるリボン要素の強調表示が変更されたときにフレームワークによって呼び出されます。
virtual void OnChangeMenuHighlight(CMFCRibbonPanelMenuBar* pPanelMenuBar
CMFCRibbonBaseElement* pHot);
パラメーター
pPanelMenuBar
[入力] このパラメーターは使用しません。
pHot
[入力] このパラメーターは使用しません。
解説
既定では、このメソッドは何も行いません。 強調表示が変更されたときにメニューにあるリボン要素を更新するには、このメソッドをオーバーライドします。
CMFCRibbonBaseElement::OnDraw
リボン要素を描画するために、フレームワークによって呼び出されます。
virtual void OnDraw(CDC* pDC) = 0;
パラメーター
pDC
[入力] デバイス コンテキストへのポインター。
解説
特定のリボン要素の描画をカスタマイズする場合は、派生クラスでこのメソッドをオーバーライドします。
CMFCRibbonBaseElement::OnDrawKeyTip
リボン要素のキーヒントを描画するためにフレームワークによって呼び出されます。
virtual void OnDrawKeyTip(
CDC* pDC,
const CRect& rect,
BOOL bIsMenu);
パラメーター
pDC
[in]デバイス コンテキストへのポインター。
rect
[in]キーヒントの境界四角形。
bIsMenu
[in]キーヒントがポップアップ メニュー ボタン用の場合は TRUE。それ以外の場合は FAL Standard Edition。
解説
CMFCRibbonBaseElement::OnDrawMenuImage
リボン要素のメニュー イメージが描画されるときにフレームワークによって呼び出されます。
virtual BOOL OnDrawMenuImage(
CDC* pDC,
CRect rect);
パラメーター
pDC
[in]デバイス コンテキストへのポインター。
rect
[in]メニュー イメージの四角形。
戻り値
イメージが描画されたことを示す場合は常に TRUE を返します。
解説
CMFCRibbonBaseElement::OnDrawOnList
コマンド リスト ボックスにリボン要素を描画するためにフレームワークによって呼び出されます。
virtual void OnDrawOnList(
CDC* pDC,
CString strText,
int nTextOffset,
CRect rect,
BOOL bIsSelected,
BOOL bHighlighted);
パラメーター
pDC
[in]リボン要素のデバイス コンテキストへのポインター。
strText
[in]表示テキスト。
nTextOffset
[in]リスト ボックスの左側から表示テキストまでの距離 (ピクセル単位)。
rect
[in]リボン要素の表示四角形。
bIsSelected
[入力] このパラメーターは使用しません。
bHighlighted
[入力] このパラメーターは使用しません。
解説
コマンド リスト ボックスには、ユーザーがクイック アクセス ツール バーをカスタマイズできるようにするためのリボン要素が表示されます。
CMFCRibbonBaseElement::OnKey
ユーザーがキーヒントを押し、リボン要素にフォーカスがあるときに、フレームワークによって呼び出されます。
virtual BOOL OnKey(BOOL bIsMenuKey);
パラメーター
bIsMenuKey
[in]キーヒントにポップアップ メニューが表示される場合は TRUE。それ以外の場合は FAL Standard Edition。
戻り値
イベントが処理された場合は TRUE。それ以外の場合は FAL Standard Edition。
解説
CMFCRibbonBaseElement::OnMenuKey
ユーザーが メイン パネルのメニュー キーヒントを押したときにフレームワークによって呼び出されます。
virtual BOOL OnMenuKey(UINT nUpperChar);
パラメーター
nUpperChar
[入力] このパラメーターは使用しません。
戻り値
常に FAL Standard Edition を返します。
解説
既定では、このメソッドは常に FAL Standard Edition を返します。 ユーザーがメイン パネルのメニュー キーヒントを押したときに応答するには、このメソッドをオーバーライドします。
CMFCRibbonBaseElement::OnProcessKey
ユーザーがショートカット キーを押したときにフレームワークによって呼び出されます。
virtual BOOL OnProcessKey(UINT nChar);
パラメーター
nChar
[入力] このパラメーターは使用しません。
戻り値
常に FAL Standard Edition を返します。
解説
リボン要素でショートカット キーを処理する場合は、このメソッドをオーバーライドします。
CMFCRibbonBaseElement::OnRTLChanged
レイアウトの方向が変わるときにフレームワークによって呼び出されます。
virtual void OnRTLChanged(BOOL bIsRTL);
パラメーター
bIsRTL
[入力] このパラメーターは使用しません。
解説
既定では、このメソッドは何も行いません。 レイアウトの方向が変更されたときにリボン要素を調整するには、このメソッドをオーバーライドします。 既定のレイアウト方向は左から右です。
CMFCRibbonBaseElement::OnSetFocus
リボン要素が入力フォーカスを受け取るか失ったときにフレームワークによって呼び出されます。
virtual void OnSetFocus(BOOL B);
解説
アプリケーションでリボン要素のフォーカスの変更を処理する場合は、派生クラスでこのメソッドをオーバーライドします。
CMFCRibbonBaseElement::OnShow
リボン要素を表示または非表示にするためにフレームワークによって呼び出されます。
virtual void OnShow(BOOL bShow);
パラメーター
bShow
[入力] このパラメーターは使用しません。
解説
既定では、このメソッドは何も行いません。 リボン要素を表示または非表示にするには、このメソッドをオーバーライドします。
CMFCRibbonBaseElement::OnShowPopupMenu
リボン要素にポップアップ メニューが表示される前に、フレームワークによって呼び出されます。
virtual void OnShowPopupMenu();
解説
このメソッドは、リボン 要素にポップアップ メニューが表示されることをリボン バーの親ウィンドウに通知します。
CMFCRibbonBaseElement::P ostMenuCommand
リボン要素のポップアップ メニューを閉じ、親メニューに閉じるメッセージを送信します。
void PostMenuCommand(UINT uiCmdId);
パラメーター
uiCmdId
[in]パラメーターは使用されません。
解説
閉じるメッセージは、リボン要素がポップアップ メニューにある場合にのみ送信されます。
CMFCRibbonBaseElement::Redraw
リボン要素の表示を更新します。
virtual void Redraw();
解説
このメソッドは、RDW_INVALIDATE、RDW_ERAStandard Edition、およびRDW_UPDATENOWフラグを設定して CWnd::RedrawWindow を呼び出して、リボン要素の表示四角形を再描画します。
CMFCRibbonBaseElement::SetACCData
リボン要素のアクセシビリティ データを設定します。
virtual BOOL SetACCData(
CWnd* pParent,
CAccessibilityData& data);
パラメーター
pParent
リボン要素の親ウィンドウ。
data
リボン要素のアクセシビリティ データ。
戻り値
常に TRUE が返されます。
解説
既定では、このメソッドはリボン要素のアクセシビリティ データを設定し、常に TRUE を返します。 アクセシビリティ データを設定し、成功または失敗を示す値を返すようにするには、このメソッドをオーバーライドします。
CMFCRibbonBaseElement::SetCompactMode
リボン要素の表示サイズを設定します。
virtual void SetCompactMode(BOOL bCompactMode = TRUE);
パラメーター
bCompactMode
[in]リボン要素の表示サイズを小さくする場合は TRUE。FAL Standard Edition リボン要素の表示サイズを大きくします。
解説
次の表は、このメソッドのロジックをまとめたものです。
| bCompactMode | 現在のリボン要素のサイズ | 新しいリボン要素のサイズ |
|---|---|---|
| TRUE | コンパクト | 変更はありません。 |
| TRUE | 中級 | 可能であればコンパクト。 |
| TRUE | Large | 可能であれば中間。 |
| FALSE | コンパクト | 可能な場合は中間。それ以外の場合は大きい。 |
CMFCRibbonBaseElement::SetData
データ項目をリボン要素に関連付けます。
void SetData(DWORD_PTR dwData);
パラメーター
dwData
[in]データ値。
CMFCRibbonBaseElement::SetDefaultMenuLook
リボン要素をポップアップ コマンドとして表示するように設定します。
void SetDefaultMenuLook(BOOL bIsDefaultMenuLook = TRUE);
パラメーター
bIsDefaultMenuLook
[in]リボン要素をポップアップ コマンドとして表示するように設定する場合は TRUE。それ以外の場合は FAL Standard Edition。
解説
CMFCRibbonBaseElement::SetDescription
リボン要素の説明を設定します。
virtual void SetDescription(LPCTSTR lpszText);
パラメーター
lpszText
[in]リボン要素の説明。
解説
フレームワークは、ステータス バー、ツールヒント、またはメニュー ボタンの下に新しい説明を表示します。
CMFCRibbonBaseElement::SetID
リボン要素のコマンド ID を設定します。
virtual void SetID(UINT nID);
パラメーター
nID
[入力] コマンド ID。
CMFCRibbonBaseElement::SetInitialMode
リボン要素の初期表示サイズを設定します。
virtual void SetInitialMode(BOOL bOneRow = FALSE);
パラメーター
bOneRow
[in]リボン要素の表示サイズをコンパクトまたは中間に制限する場合は TRUE。それ以外の場合は FAL Standard Edition。
解説
リボン要素の表示サイズは、コンパクト、中間、または大にすることができます。
CMFCRibbonBaseElement::SetKeys
リボン要素のキーヒントを設定します。
virtual void SetKeys(
LPCTSTR lpszKeys,
LPCTSTR lpszMenuKeys=NULL);
パラメーター
lpszKeys
[in]リボン要素のキーヒント。
lpszMenuKeys
[in]リボン要素のポップアップ メニューのキーヒント。
CMFCRibbonBaseElement::SetOriginal
リボン要素の元のリボン要素を設定します。
virtual void SetOriginal(CMFCRibbonBaseElement* pOriginal);
パラメーター
pOriginal
[in]リボン要素へのポインター。
解説
別のコンテナーにコピーされたリボン要素は、元のリボン要素へのポインターを保持します。
CMFCRibbonBaseElement::SetParentCategory
リボン要素の親カテゴリを設定します。
virtual void SetParentCategory(CMFCRibbonCategory* pParent);
パラメーター
pParent
[in]リボン カテゴリへのポインター。
解説
リボン コントロールのタブ付きグループは、カテゴリと呼ばれます。
CMFCRibbonBaseElement::SetParentMenu
リボン要素の親メニュー コンテナーを設定します。
virtual void SetParentMenu(CMFCRibbonPanelMenuBar* pMenuBar);
パラメーター
pMenuBar
[in]親メニュー。
解説
CMFCRibbonBaseElement::SetParentRibbonBar
リボン要素の親リボン バーを設定します。
virtual void SetParentRibbonBar(CMFCRibbonBar* pRibbonBar);
パラメーター
pRibbonBar
[in]親リボン バーへのポインター。
解説
CMFCRibbonBaseElement::SetRect
リボン要素の表示四角形の寸法を設定します。
void SetRect(CRect rect);
パラメーター
rect
[in]四角形の寸法。
解説
CMFCRibbonBaseElement::SetText
リボン要素のテキストとキーヒントを設定します。
virtual void SetText(LPCTSTR lpszText);
パラメーター
lpszText
[in]リボン要素のテキストとキーヒント。
解説
リボン要素のキーヒントを設定するには、改行エスケープ シーケンスの後にキーヒント文字を lpszText に 追加します。
例
//Set the text for the ribbon element
SetText(_T("Margins"))
//Set the text and a single-letter keytip
SetText(_T("Margins\nm"))
//Set the text and a multiple-letter keytip
SetText(_T("Line Numbers\nln"))
CMFCRibbonBaseElement::SetTextAlwaysOnRight
右側に表示するリボン要素のテキストを設定します。
virtual void SetTextAlwaysOnRight(BOOL bSet = TRUE);
パラメーター
bSet
[in]右側にテキストを表示する場合は TRUE。それ以外の場合は FAL Standard Edition。
解説
CMFCRibbonBaseElement::SetToolTipText
リボン要素のツールヒント テキストを設定します。
virtual void SetToolTipText(LPCTSTR lpszText);
パラメーター
lpszText
[in]ツールヒントテキスト。
CMFCRibbonBaseElement::SetVisible
リボン要素の表示を設定します。
void SetVisible(BOOL bIsVisible);
パラメーター
bIsVisible
[in]リボン要素を表示する場合は TRUE。FAL Standard Edition リボン要素を非表示にします。
解説
CMFCRibbonBaseElement::StretchHorizontally
リボン要素の幅を拡大します。
virtual void StretchHorizontally();
解説
既定では、このメソッドはデバッグ ビルドでアサーション エラーを生成するため、呼び出さないでください。 リボン要素の幅を拡大するには、このメソッドをオーバーライドします。
CMFCRibbonBaseElement::StretchToWholeRow
リボン要素の表示高さを、指定した行の高さに変更します。
virtual BOOL StretchToWholeRow(
CDC* pDC,
int nHeight);
パラメーター
pDC
[入力] このパラメーターは使用しません。
nHeight
[in]行の高さ。
戻り値
表示の高さが設定されている場合は TRUE。それ以外の場合は FAL Standard Edition。
解説
リボン要素の表示高さを指定した行の高さに変更するには、このメソッドをオーバーライドします。
CMFCRibbonBaseElement::UpdateTooltipInfo
リボン要素のコマンド リソースを使用して、ツールヒントテキストを更新します。
virtual void UpdateTooltipInfo();
解説
CMFCRibbonBaseElement::HasFocus
親要素にキーボード フォーカスがあるかどうかを示します。
virtual BOOL HasFocus() const;
戻り値
リボン要素にフォーカスがある場合は TRUE。それ以外の場合は FAL Standard Edition。
解説
関連項目
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示