CMFCRibbonBaseElement クラス
CMFCRibbonBaseElement クラスは、リボン バーに追加できるすべての要素の基本クラスです。リボン要素とは、リボン ボタン、リボン チェック ボックス、リボン コンボ ボックスなどです。
class CMFCRibbonBaseElement : public CObject
メンバー
.gif "Bb983027.collapse_all(ja-jp,VS.110).gif")
パブリック コンストラクター
名前 |
説明 |
|---|---|
CMFCRibbonBaseElement |
CMFCRibbonBaseElement オブジェクトを構築します。 |
パブリック メソッド
名前 |
説明 |
|---|---|
リボン要素の KeyTip を KeyTip の配列に追加します。 |
|
指定されたリボン コマンドのリスト ボックスに、リボン要素を追加します。 |
|
クイック アクセス ツール バーにリボン要素を追加できるかどうかを示します。 |
|
リボン要素のサイズをコンパクト サイズにできるかどうかを示します。 |
|
リボン要素の高さがリボンの行の高さに合わせて縦方向に拡大可能かどうかを指定します。 |
|
リボン要素の幅を変更できるかどうかを示します。 |
|
リボン要素のサイズ設定をクリーンアップします。 |
|
リボン要素のポップアップ メニューを閉じます。 |
|
指定された CMFCRibbonBaseElement の状態を現在のオブジェクトにコピーします。 |
|
リボン要素を破棄します。 |
|
リボン要素のイメージを描画します。 |
|
指定されたリボン要素へのポインターが現在のオブジェクトをポイントしている場合、そのポインターを返します。 |
|
リボン要素に指定されたデータが含まれている場合は、リボン要素へのポインターを取得します。 |
|
指定したコマンド ID でリボン要素が識別される場合、そのリボン要素へのポインターを取得します。 |
|
元のリボン要素が指定したリボン要素に一致する場合、リボン要素へのポインターを取得します。 |
|
リボン要素のコンパクト サイズを返します。 |
|
リボン要素に関連付けられているユーザー定義データを取得します。 |
|
リボン要素の説明を返します。 |
|
リボン要素のポップアップ メニューがドロップダウンされている場合に、リボン要素へのポインターを取得します。 |
|
現在のリボン要素を指定された配列に追加します。 |
|
現在のリボン要素に指定したコマンド ID が含まれている場合、指定した配列に現在のリボン要素を追加します。 |
|
リボン要素が強調表示されている場合、そのリボン要素へのポインターを取得します。 |
|
リボン要素のコマンド ID を返します。 |
|
リボン要素のイメージ サイズを返します。 |
|
サイズが中間状態になっているリボン要素のサイズを返します |
|
リボン要素に関連付けられた KeyTip を返します。 |
|
リボン要素の KeyTip の境界を示す四角形を取得します。 |
|
KeyTip テキストのサイズを取得します。 |
|
リボン グループにおけるリボン要素の表示位置を示します。 |
|
ボタンに関連付けられた KeyTip を返します。 |
|
リボン要素の通知コマンドの ID を取得します。 |
|
元のリボン要素を取得します。 |
|
リボン要素のリボン カテゴリを取得します。 |
|
リボン要素が含まれているリボン パネルを取得します。 |
|
リボン要素の親リボン バーを取得します。 |
|
リボン要素の親ウィンドウを取得します。 |
|
ユーザーが現在リボン要素をクリックしている場合、そのリボン要素へのポインターを取得します。 |
|
クイック アクセス ツール バーに配置されているリボン要素のコマンド ID を取得します。 |
|
リボン要素の外接する四角形を返します。 |
|
リボン要素の標準サイズを返します。 |
|
リボン要素の現在のサイズを返します。 |
|
リボン要素に関連付けられたテキストを返します。 |
|
リボン要素のツールヒント テキストを返します。 |
|
リボン要素の最上位のリボン バーを取得します。 |
|
リボン要素が簡易モードを持つかどうかを指定します。 |
|
親要素にキーボード フォーカスがあるかどうかを示します。 |
|
リボン要素に中間モードがあるかどうかを示します。 |
|
リボン要素に大モードがあるかどうかを指定します。 |
|
リボン要素にメニューがあるかどうかを示します。 |
|
指定した点がリボン要素に含まれている場合に、そのリボン要素へのポインターを取得します。 |
|
リボン要素が他のリボン要素と共に垂直に配置されるかどうかを示します。 |
|
リボン要素のイメージ サイズが常に大きいかどうかを示します。 |
|
リボン要素が自動繰り返しモードになっているかどうかを示します。 |
|
リボン要素がチェックされているかどうかを示します。 |
|
リボン要素が簡易モードであるかどうかを示します。 |
|
|
|
リボン要素が無効であるかどうかを示します。 |
|
リボン要素がドロップダウンされてポップアップ メニューが表示されているかどうかを調べます。 |
|
リボン要素にフォーカスがあるかどうかを示します。 |
|
リボン ギャラリーにリボン要素が含まれているかどうかを示します。 |
|
リボン要素を強調表示するかどうかを指定します。 |
|
リボン要素の現在のイメージが中間サイズであるかどうかを示します。 |
|
リボン要素の現在のイメージが大きいサイズであるかどうかを示します。 |
|
メニューにリボン要素が含まれているかどうかを示します。 |
|
ユーザーがリボン要素をクリックしたかどうかを示します。 |
|
リボン要素がクイック アクセス ツール バーに含まれているかどうかを示します。 |
|
リボン要素が表示区分線であるかどうかを示します。 |
|
リボン要素が、通常の境界線を表示するグループに含まれるかどうかを示します。 |
|
ツールヒントをリボン要素の下に表示するかどうかを示します。 |
|
リボン要素をキーボードで選択できるかどうかを示します。 |
|
リボン要素のテキストを右側に表示するかどうかを示します。 |
|
リボン要素が現在表示されているかどうかを示します。 |
|
リボン要素の表示高さが、そのリボン要素を含むリボン パネルの表示の高さと同じであるかどうかを示します。 |
|
リボン要素の親ウィンドウにコマンド通知を送信します。 |
|
ユーザーがリスト内にあるリボン要素を強調表示したときに、リボン バーの親ウィンドウに通知します。 |
|
指定したクイック アクセス ツール バーにリボン要素を追加します。 |
|
リボン要素のツールヒントを更新します。 |
|
維持されたユーザー入力に応答してリボン要素を更新します。 |
|
リボン要素のテキストのサイズを計算します。 |
|
メニューに含まれるリボン要素の強調表示が変更されたときに、フレームワークによって呼び出されます。 |
|
リボン要素を描画するために、フレームワークによって呼び出されます。 |
|
リボン要素の KeyTip を描画するために、フレームワークによって呼び出されます |
|
リボン要素のメニュー イメージが描画されるときに、フレームワークによって呼び出されます。 |
|
コマンド リスト ボックス内のリボン要素を描画するために、フレームワークによって呼び出されます。 |
|
ユーザーが KeyTip を押し、リボン要素にフォーカスがあるときに、フレームワークによって呼び出されます |
|
レイアウトの方向が変更されたときに、フレームワークによって呼び出されます。 |
|
リボン要素の表示と非表示を切り替えるために、フレームワークによって呼び出されます。 |
|
リボン要素にポップアップ メニューを表示するときに、フレームワークによって呼び出されます。 |
|
リボン要素の表示を更新します。 |
|
リボン要素のアクセシビリティ データを設定します。 |
|
リボン要素の表示サイズを設定します |
|
データ項目をリボン要素に関連付けます。 |
|
|
|
リボン要素の説明を設定します。 |
|
リボン要素のコマンド ID を設定します。 |
|
リボン要素の初期表示サイズを設定します。 |
|
リボン要素の KeyTip を設定します。 |
|
リボン要素に対して元のリボン要素を設定します。 |
|
リボン要素に対して親カテゴリを設定します。 |
|
リボン要素に対して親メニュー コンテナーを設定します。 |
|
リボン要素に対して親リボン バーを設定します。 |
|
リボン要素を表示する四角形の寸法を設定します。 |
|
リボン要素のテキストを設定します |
|
リボン要素の右側に表示するテキストを設定します。 |
|
リボン要素のツールヒント テキストを設定します。 |
|
リボン要素の表示状態を設定します。 |
|
リボン要素の幅を広げます。 |
|
リボン要素の表示の高さを、指定した行の高さに変更します。 |
|
リボン要素のコマンド リソースを使用してツールヒント テキストを更新します。 |
プロテクト メソッド
名前 |
説明 |
|---|---|
ユーザーがショートカット キーを押したときに、フレームワークによって呼び出されます。 |
|
リボン要素が入力フォーカスを受け取ったか失ったときに、フレームワークによって呼び出されます。 |
解説
CMFCRibbonBaseElement クラスは、コマンド ID、テキスト ラベル、ツールヒント テキスト、要素の説明、および状態 (フォーカスを置く、強調表示する、押す、無効にする、チェックする、またはドロップダウンするなど) が含まれるすべてのリボン要素に共通のプロパティを定義します。
リボン要素のイメージ サイズは、RibbonImageType メンバーに次のいずれかの値を指定することによって定義します。
RibbonImageLarge
RibbonImageSmall
そのサイズに応じて、リボン要素には小さいイメージと大きいイメージのいずれかが表示されます。
使用例
次の例は、CMFCRibbonBaseElement クラスのさまざまなメソッドの使用方法を説明しています。この例は、CMFCRibbonStatusBar クラスからの CMFCRibbonBaseElement オブジェクトの取得方法、リボン要素の説明の設定方法、テキストの設定方法、KeyTip の設定方法、リボン要素のツールヒント テキストの設定方法を示しています。このコード スニペットは クライアント サンプルを描画の一部です。
// 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