HypGetOption

データ・プロバイダ・タイプ: Essbase、Financial Management、Planning、Hyperion Enterprise

説明

HypGetOption()は、デフォルトおよびシート固有の両方のSmart Viewオプションを取得します。2つのオプション・タイプでVBAコマンドを区別する必要はありません。

HypGetGlobalOptionも参照してください。

構文

HypGetOption (vtItem,vtRet,vtSheetName)

ByVal vtItem As Variant

ByRef vtRet As Variant

ByVal vtSheetName As Variant

パラメータ

vtItem: 特定のオプションを参照するインデックスまたは定数。オプションの詳細は、表6を参照してください。また、使用可能なオプションのリストがsmartview.basの「Enumeration of options index to be used for HypGetOption/HypSetOption」の下に示されます。

vtRet: 出力変数

vtSheetName: シート・レベル・オプションのシート名。有効なシート名が指定されてない場合、デフォルトのオプションが使用されます。

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

      Public Declare Function HypGetOption Lib "HsAddin" (ByVal vtItem As Variant, ByRef vtRet As Variant, ByVal vtSheetName As Variant) As Long

Sub Example_HypGetOption()

sts = HypGetOption(HSV_ZOOMIN, Var, "Sheet2") 'get zoom in option for sheet2
sts = HypGetOption(1, Var, "") 'get default zoom in option

End Sub

表 6. HypGetOptionとHypSetOptionのオプション定数

	定数	データ型	コメント
HSV_ZOOMIN	1	数値	ズーム・イン・レベルを設定します: 0 = 次のレベル 1 = すべてのレベル 2 = 最下位レベル 3 = 兄弟レベル 4 = 同一レベル 5 = 同一世代 6 = 式
HSV_INCLUDE_SELECTION	2	ブール	「選択を含める」チェック・ボックスを選択します
HSV_WITHIN_SELECTEDGROUP	3	ブール	「選択したグループ内」チェック・ボックスを選択します
HSV_REMOVE_UNSELECTEDGROUP	4	ブール	「選択されていないグループの削除」チェック・ボックスを選択します
HSV_INDENTATION	5	数値	「インデント」オプションを選択します 0 = インデントなし 1 = サブ・アイテムのインデント 2 = 合計のインデント
HSV_SUPPRESSROWS_MISSING	6	ブール	データなしの行またはデータが欠落している行が抑制されます
HSV_SUPPRESSROWS_ZEROS	7	ブール	ゼロのみを含む行が抑制されます
HSV_SUPPRESSROWS_UNDERSCORE	8	ブール	メンバー名にアンダースコア文字を含む行が抑制されます
HSV_SUPPRESSROWS_NOACCESS	9	ブール	ユーザーに表示するためのセキュリティ・アクセス権がないデータが含まれている行が抑制されます
HSV_SUPPRESSROWS_REPEATEDMEMBERS	10	ブール	グリッドの方向にかかわらず繰り返されるメンバー名を含む行が抑制されます。
HSV_SUPPRESSROWS_INVALID	11	ブール	無効な値のみを含む行が抑制されます
HSV_ANCESTOR_POSITION	12	数値	階層での祖先の位置を指定します: 0 = 最上位 1 = 最下位
HSV_MISSING_LABEL	13	テキスト	データが欠落しているデータ・セルに、#Missing、#Numeric Zero、または選択したテキストを表示します。
HSV_NOACCESS_LABEL	14	テキスト	ユーザーが表示する権限がないデータ・セルに、#NoAccess、#Numeric Zero、または選択したテキストを表示します。
HSV_CELL_STATUS	15	数値	実際のデータを表示するかわりに、セルの計算またはプロセス・ステータスを表示できます: 0 = データ 1 = 計算ステータス 2 = プロセス管理
HSV_MEMBER_DISPLAY	16	数値	セルにメンバー名を表示する方法を指定します: 0 = 名前のみ 1 = 名前と説明 2 = 説明のみ
HSV_INVALID_LABEL	17	テキスト	無効なデータを含むデータ・セルに、#Invalid、#Numeric Zero、または選択したテキストを表示します。
HSV_SUBMITZERO	18	ブール	HSV_MISSING_LABEL、HSV_NOACCESS_LABELまたはSV_INVALID_LABELオプションで#NumericZeroを指定した場合、データベースに0を送信できます。
HSV_19	19		今後の使用に予約
HSV_20	20		今後の使用に予約
HSV_PRESERVE_FORMULA_COMMENT	21	ブール	クエリー中に、グリッドに式とコメントが保存されます。
HSV_22	22		今後の使用に予約
HSV_FORMULA_FILL	23	ブール	メンバー・セルに関連付けられている式を、ズーム・インの結果として取得されたメンバーに伝播します。 HSV_PRESERVE_FORMULA_COMMENTとHSV_EXCEL_FORMATTINGの両方が有効である場合、ズーム・インの結果として取得されたメンバーにセルのフォーマットを伝播します。メンバーとデータ・セルの両方の式に適用されます。
HSV_EXCEL_FORMATTING	30	ブール	Excelフォーマット・チェック・ボックスを選択します
HSV_RETAIN_NUMERIC_FORMATTING	31	ブール	ユーザーが次元にドリルダウンするとき、HSV_SCALEに指定したスケールまたはHSV_DECIMALPLACESの小数点以下の桁数(あるいは両方)をデータに使用します。
HSV_THOUSAND_SEPARATOR	32	ブール	数値データでカンマまたは他の3桁区切り文字を使用します。Excelの「オプション」の「インターナショナル」タブで、桁区切り記号として#または$を使用しないでください。
HSV_NAVIGATE_WITHOUTDATA	33	ブール	ナビゲート中にソース・データを計算しないようにしてピボット、ズーム、選択項目のみ保持、選択項目のみ削除などの操作を高速化できます。データを取得する準備ができたら、「データなし操作」を無効にします。
HSV_ENABLE_FORMATSTRING	34	ブール	Essbase固有。 Essbaseでは、様々なデータ型に関連付けられるフォーマット文字列が提供されます。有効にすると、数値のかわりにユーザー固有のテキストを表示します。
HSV_ENHANCED_COMMENT_HANDLING	35	ブール	コメントが含まれているアド・ホック・グリッドでコメントとメンバー名をレビューし、修正できます。
HSV_ADJUSTCOLUMNWIDTH	36	ブール	セルの内容に合せて列の幅を自動的に調整します。
HSV_DECIMALPLACES	37	数値	表示する小数点以下の桁数を指定します。
HSV_SCALE	38	数値	選択されたスケールに基づいて表示される数値データのスケールを指定します。
HSV_MOVEFORMATS_ON_ADHOC	39	ブール	親セル・フォーマットをコピーしてセルにズーム・インし、操作後にセルの場所が変更された場合でもこのフォーマットを保持します。
HSV_DISPLAY_INVALIDDATA	40	ブール	無効なデータを表示します。
HSV_SUPPRESSCOLUMNS_MISSING	41	ブール	データベース内にデータが存在しないセルを含む列が抑制されます(データなしはゼロとは異なります。ゼロはデータ値です)。
HSV_SUPPRESSCOLUMNS_ZEROS	42	ブール	ゼロのみを含む列が抑制されます。
HSV_SUPPRESSCOLUMNS_NOACCESS	43	ブール	ユーザーに表示するためのセキュリティ・アクセス権がないデータが含まれている列が抑制されます。
HSV_SUPPRESS_MISSINGBLOCKS	44	ブール	データベースにデータが存在しないセルのブロックが抑制されます。
HSV_DOUBLECLICK_FOR_ADHOC	101	ブール	ダブルクリックによって空のワークシートにデフォルトのグリッドが取得され、セル・コンテンツがズーム・インまたはズーム・アウトされるように指定します。
HSV_UNDO_ENABLE	102	ブール	「元に戻す」を有効または無効にします。元に戻すことができる操作の数をHSV_NUMBER_OF_UNDO_ACTIONパラメータに指定します。
HSV_103	103		今後使用するために予約されています。
HSV_LOGMESSAGE_DISPLAY	104	数値	メッセージ表示レベル設定を指定します: 0 = 情報 1 = 警告 2 = エラー 3 = なし 4 = 拡張情報 5 = プロファイル
HSV_ROUTE_LOGMESSAGE_TO_FILE	105	ブール	「メッセージをファイルに送る」チェック・ボックスを有効または無効にします。
HSV_CLEAR_LOG_ON_NEXTLAUNCH	106	ブール	Excelが閉じた後に表示される次のログ・メッセージの生成が開始されると、ログ・ファイルがクリアされます。
HSV_REDUCE_EXCEL_FILESIZE	107	ブール	使用すべきではない次の場合を除き、常に有効にする必要があります: 9.3.1.6以前のSmart Viewリリースのユーザー、またはSmart Viewリリースに関係なくMicrosoft OfficeのユーザーにExcelワークブックを送信する場合。これらのワークブックでは: 関数を含むグリッドは、データを表示する前にリフレッシュする必要があります。アド・ホック・モードで、POV設定が失われます。この動作は、新規のアド・ホック・グリッドの動作と同じです。 9.3.1.6以前のSmart Viewリリースのユーザー、またはSmart Viewリリースに関係なくMicrosoft Officeのユーザーから送信されたワークブックを開きます
HSV_ENABLE_RIBBON_CONTEXT	108	ブール	Smart Viewのリボンのボタンを使用した後に、アクティブなデータ・プロバイダのリボンを自動的に表示します。
HSV_DISPLAY_HOMEPANEL_ONSTARTUP	109	ブール	「Smart Viewホーム」パネルの「起動時に表示」チェック・ボックスを有効または無効にします。有効にすると、Smart Viewのリボンで「パネル」アイコンを選択したときに、「Smart Viewホーム」パネルが表示されます。無効にすると、最後に開いていたパネルが表示されます。
HSV_SHOW_COMMENTDIALOG_ON_REFRESH	110	ブール	有効にすると、グリッドにコメントがある場合、リフレッシュ時にコメント・エディタがユーザーに表示されます。無効にすると、Smart Viewのリボンからユーザーがコメント・エディタを起動できます。
HSV_NUMBER_OF_UNDO_ACTION	111	数値	1回の操作で許可される元に戻す処理とやり直し処理の数(0から100)。 HSV_UNDO_ENABLEパラメータと一緒に機能します。
HSV_NUMBER_OF_MRU_ITEMS	112	数値	「Smart Viewホーム」、およびSmart Viewのリボンの「開く」メニューに表示される、最後に使用した接続の数(15以下)。
HSV_ROUTE_LOGMESSAGE_FILE_LOCATION	113	テキスト	ログ・メッセージをファイルに保存します。
HSV_DISABLE_SMARTVIEW_IN_OUTLOOK	114	ブール	OutlookでSmart Viewタスク・リストを使用しない場合に、OutlookでSmart Viewを使用不可にします。
HSV_DISPLAY_SMARTVIEW_SHORTCUT_MENU_ONLY	115	ブール	ショートカット・メニューにSmart Viewのメニュー・アイテムのみを表示します。このオプションを設定しない場合、ショートカット・メニューにはExcelとSmart Viewの両方のアイテムが表示されます。
HSV_DISPLAY_DRILL_THROUGH_REPORT_TOOLTIP	116	ブール	セル上にマウスを移動したときに使用可能なドリルスルー・レポートのリストをデフォルトで表示します。
HSV_SHOW_PROGRESSINFORMATION	117	ブール	HSV_PROGRESSINFO_TIMEDELAYに定義した秒数が経過してから操作が開始すると、「Smart View進捗」ステータス・バーが表示されるように指定します。
HSV_PROGRESSINFO_TIMEDELAY	118	数値	操作が始まってから「Smart View進捗」ステータス・バーが表示されるまでの時間(秒)。