WorksheetBase クラス

定義

Microsoft Office Excel 用のドキュメント レベルのプロジェクトにある Sheetn クラスの基底クラスを提供します。

public ref class WorksheetBase abstract : IDisposable, Microsoft::Office::Tools::Excel::IWorksheetExtension, System::ComponentModel::IComponent, System::ComponentModel::ISupportInitialize, System::Windows::Forms::IBindableComponent
[System.ComponentModel.ToolboxItem(false)]
public abstract class WorksheetBase : IDisposable, Microsoft.Office.Tools.Excel.IWorksheetExtension, System.ComponentModel.IComponent, System.ComponentModel.ISupportInitialize, System.Windows.Forms.IBindableComponent
[<System.ComponentModel.ToolboxItem(false)>]
type WorksheetBase = class
    interface IWorksheetExtension
    interface IExtension
    interface EntryPoint
    interface ISupportInitialize
    interface IBindableComponent
    interface IComponent
    interface IDisposable
Public MustInherit Class WorksheetBase
Implements IBindableComponent, IComponent, IDisposable, ISupportInitialize, IWorksheetExtension
継承
WorksheetBase
属性
実装

注釈

クラスはWorksheetBase、Visual Studio を使用して作成されたSheetドキュメント レベルの Excel プロジェクトの n クラスの基本クラスです。 n クラスをSheet使用して、プロジェクト内のワークシートにプログラムでアクセスします。 クラスは WorksheetBase 、ドキュメント レベルのプロジェクトのワークシートを表す ホスト項目 です。 詳細については、「 ホスト項目」および「ホスト コントロールの概要 」および 「ワークシート ホスト項目」を参照してください。

クラスは WorksheetBase 、Excel プライマリ相互運用機能アセンブリの Microsoft.Office.Interop.Excel.Worksheet クラスと同じメンバーを提供しますが、次の機能が追加されます。

  • Controls プロパティ。 Excel ワークシートに管理コントロールを追加したり、実行時にコントロールを削除したりするには、このプロパティを使用します。

  • InnerObject プロパティ。 ワークシート ホスト項目の基になる Microsoft.Office.Interop.Excel.Worksheet オブジェクトを取得するには、このプロパティを使用します。

  • GetAutomationObject メソッド プロジェクト内のクラスをワークシートの VBA コードに公開するには、このメソッドをオーバーライドします。

  • Excel オブジェクト モデルのアプリケーション レベルでのみ提供される、 や ChangeなどのActivateEventドキュメント レベルのイベント。 つまり、Excel オブジェクト モデルでは、これらのイベントは クラスではなく Microsoft.Office.Interop.Excel.Worksheet クラスMicrosoft.Office.Interop.Excel.Applicationで定義されます。

ワークシート ホスト項目の作成

Office プロジェクトでプログラムでオブジェクトを作成 WorksheetBase することはできません。

ドキュメント レベルのプロジェクトでは、エンド ユーザーがブックをSheet開くと、Visual Studio Tools for Office ランタイムによって n 個のクラス (からWorksheetBase派生) が自動的にインスタンス化されます。 詳細については、「 Programming Document-Level Customizations」を参照してください。

アプリケーション レベルのプロジェクトでは、 メソッドを使用してプログラムでワークシート ホスト項目を GetVstoObject 作成できます。 作成するワークシート ホスト項目は Microsoft.Office.Tools.Excel.Worksheet 、オブジェクトではなく WorksheetBase オブジェクトです。 詳細については、「 Extending Word Documents and Excel Workbooks in VSTO Add-ins at Run Time」を参照してください。

使用

このタイプは、.NET Framework 4 以降を対象とする Office プロジェクトでのみ使用されます。 このタイプを定義するアセンブリは、Visual Studio Tools for Office Runtime の一部ではありません。 このアセンブリをソリューションと共に配置する必要があります。 詳細については、「Visual Studio Tools for Office ランタイムのアセンブリ」を参照してください。

コンストラクター

WorksheetBase(Factory, IServiceProvider, String, String)

Microsoft Office Excel 用のドキュメント レベルのプロジェクトにある Sheetn クラスの基底クラスを提供します。

プロパティ

Application

Microsoft Office Excel アプリケーションを表す Application オブジェクトを取得します。

AutoFilter

フィルタリングが有効になっている場合にワークシートのフィルターされたリストに関する情報を提供する AutoFilter を取得します。 フィルタリングがオフになっている場合は null を取得します。

AutoFilterMode

フィルター処理がワークシートで現在有効になっているかどうか (フィルター処理ドロップダウン矢印が現在有効になっているかどうか) を示す値を取得または設定します。

Base

この Worksheet オブジェクトが拡張する WorksheetBase オブジェクトを取得します。

BindingContext

Microsoft Office Excel 用のドキュメント レベルのプロジェクトにある Sheetn クラスの基底クラスを提供します。

Cells

ワークシート上の全セル (現在使用中のセル以外も) を表す Range オブジェクトを取得します。

CircularReference

ワークシート上の最初の循環参照を含む範囲を表す Range オブジェクトを取得します。ワークシートに循環参照がない場合は null を取得します。

Columns

ワークシート上の 1 つ以上の列を表す Range オブジェクトを取得します。

Comments

ワークシート内のすべてのコメントを示す Comments コレクションを取得します。

ConsolidationFunction

現在の統合に使用される関数のコードを取得します。

ConsolidationOptions

統合オプションの、3 要素の Array を取得します。

ConsolidationSources

ワークシートの現在の統合用の、参照元シートの名前と範囲を指定する、文字列の Array を取得します。

Controls

ワークシートにあるマネージド コントロールのコレクションを取得します。

Creator

ワークシートを作成したアプリケーションを示す値を取得します。

CustomProperties

ワークシートに関連付けられた識別情報を表す CustomProperties オブジェクトを取得します。

DataBindings

Microsoft Office Excel 用のドキュメント レベルのプロジェクトにある Sheetn クラスの基底クラスを提供します。

DataHost

Microsoft Office Excel 用のドキュメント レベルのプロジェクトにある Sheetn クラスの基底クラスを提供します。

DisplayPageBreaks

ワークシート上の改ページ (自動と手動の両方) を表示するかどうかを示す値を取得または設定します。

DisplayRightToLeft

ワークシートを左から右ではなく、右から左へ表示するかどうかを示す値を取得または設定します。

EnableAutoFilter

ユーザー インターフェイスのみの保護がオンになっているときに、オートフィルターの矢印が有効になっているかどうかを示す値を取得または設定します。

EnableCalculation

Microsoft Office Excel が必要に応じて自動的にワークシートを再計算するかどうかを示す値を取得または設定します。

EnableFormatConditionsCalculation

条件付き書式が自動的に適用されるかどうかを決定する値を取得または設定します。

EnableOutlining

ユーザー インターフェイスのみの保護がオンになっているときに、アウトライン記号が有効になっているかどうかを示す値を取得または設定します。 この型またはメンバーは 2007 Microsoft Office システムのプロジェクト専用です。 スマート タグは Office 2010 では非推奨とされています。 この型またはメンバーは 2007 Microsoft Office システムのプロジェクト専用です。 スマート タグは Office 2010 では非推奨とされています。

EnablePivotTable

ユーザー インターフェイスのみの保護がオンになっているときに、PivotTable のコントロールとアクションが有効になっているかどうかを示す値を取得または設定します。

EnableSelection

シート上で選択可能なセルを示す値を取得または設定します。

FilterMode

ワークシートがアクティブにデータをフィルター処理するかどうかを示す値を取得します。

HostContext

Microsoft Office Excel 用のドキュメント レベルのプロジェクトにある Sheetn クラスの基底クラスを提供します。

HPageBreaks

ワークシート上の水平方向の改ページを表す HPageBreaks コレクションを取得します。

Hyperlinks

範囲またはワークシートのハイパーリンクを表す Hyperlinks コレクションを取得します。

Index

ワークシートのコレクション内の、特定のワークシートのインデックス番号を取得します。

InnerObject

Worksheet の基になるネイティブ オブジェクトを表す WorksheetBase を取得します。

ItemProvider

Microsoft Office Excel 用のドキュメント レベルのプロジェクトにある Sheetn クラスの基底クラスを提供します。

ListObjects

ワークシート内の ListObject オブジェクトのコレクションを取得します。

MailEnvelope

ワークシートの電子メール ヘッダーを取得します。

Name

ワークシートの名前を取得または設定します。

Names

Namesすべてのワークシート固有の名前 ("WorksheetName!" プレフィックスで定義された名前) を表すコレクションを取得します。

Next

次のシートを表す Worksheet を取得します。

Outline

ワークシートのアウトラインを表す Outline を取得します。

PageSetup

ワークシートのすべてのページ設定を含む PageSetup を取得します。

Parent

ワークシートの親オブジェクトを取得します。

Previous

前のシートを表す Worksheet を取得します。

PrintedCommentPages

現在のワークシートで印刷されるコメント ページの数を取得します。 このプロパティは、Excel 2010 プロジェクトでのみ使用できます。

ProtectContents

ワークシート (個々のセル) の内容が保護されているかどうかを示す値を取得します。

ProtectDrawingObjects

図形が保護されているかどうかを示す値を取得します。

Protection

ワークシートの保護オプションを表す Protection オブジェクトを取得します。

ProtectionMode

ユーザー インターフェイスのみの保護がオンになっているかどうかを示す値を取得します。

ProtectScenarios

ワークシートのシナリオが保護されているかどうかを示す値を取得します。

QueryTables

ワークシート内のすべてのクエリ テーブルを示す QueryTables コレクションを取得します。

Range

セルまたはセルの範囲を表す Range オブジェクトを取得します。

Rows

ワークシート上の 1 つ以上の行を表す Range オブジェクトを取得します。

ScrollArea

スクロール可能な範囲を、A1 スタイルの範囲参照として取得または設定します。

Shapes

ワークシート上のすべての図形を表す Shapes オブジェクトを取得します。

Site

Microsoft Office Excel 用のドキュメント レベルのプロジェクトにある Sheetn クラスの基底クラスを提供します。

Sort

現在のワークシート内で並べ替えた値を取得します。

StandardHeight

ワークシート内のすべての行の標準 (既定) の高さをポイントで取得します。

StandardWidth

ワークシート内の列の標準 (既定) の高さを取得または設定します。

Tab

ワークシートの Tab を取得します。

Tag

ワークシートに関するデータが含まれるオブジェクトを取得または設定します。

TransitionExpEval

Microsoft Office Excel が Lotus 1-2-3 の式評価規則をワークシートで使用するかどうかを示す値を取得または設定します。

TransitionFormEntry

Microsoft Office Excel が Lotus 1-2-3 の数式入力規則をワークシートで使用するかどうかを示す値を取得または設定します。

Type

ワークシートの種類を取得します。

UsedRange

任意の時点で値を含んでいたすべてのセルを表す Range オブジェクトを取得します。

Visible

オブジェクトが表示されるかどうかを示す XlSheetVisibility 値を取得または設定します。

VPageBreaks

ワークシート上の垂直方向の改ページを表す VPageBreaks コレクションを取得します。

メソッド

Activate()

Microsoft Office Excel 用のドキュメント レベルのプロジェクトにある Sheetn クラスの基底クラスを提供します。

BeginInit()

Microsoft Office Excel 用のドキュメント レベルのプロジェクトにある Sheetn クラスの基底クラスを提供します。

CalculateMethod()

ワークシート内の数式を演算します。

ChartObjects(Object)

ワークシート上の単一の埋め込みグラフ (ChartObject) または、すべての埋め込みグラフのコレクション (ChartObjects) のいずれかを表すオブジェクトを取得します。

CheckSpelling(Object, Object, Object, Object)

Microsoft Office Excel 用のドキュメント レベルのプロジェクトにある Sheetn クラスの基底クラスを提供します。

CircleInvalid()

ワークシート上の無効なエントリを丸で囲みます。

ClearArrows()

トレース矢印をワークシートから削除します。 トレース矢印は、監査機能を使用することで追加されます。

ClearCircles()

ワークシート上の無効なエントリの丸を削除します。

Copy(Object, Object)

ワークシートをブック内の別の場所にコピーします。

Delete()

基になる Worksheet オブジェクトは削除されますが、ホスト項目は削除されません。 このメソッドを使用しないことを強くお勧めします。

Dispose()

WorksheetBase クラスの現在のインスタンスによって使用されているすべてのリソースを解放します。

EndInit()

Microsoft Office Excel 用のドキュメント レベルのプロジェクトにある Sheetn クラスの基底クラスを提供します。

Evaluate(Object)

Microsoft Office Excel の名前をオブジェクトまたは値に変換します。

ExportAsFixedFormat(XlFixedFormatType, Object, Object, Object, Object, Object, Object, Object, Object)

指定した書式のファイルにエクスポートします。

FinishInitialization()

Microsoft Office Excel 用のドキュメント レベルのプロジェクトにある Sheetn クラスの基底クラスを提供します。

GetAutomationObject()

ワークシート内の VBA コードで使用できるオブジェクトを取得するために、Visual Studio Tools for Office ランタイムによって呼び出されます。

Initialize()

Microsoft Office Excel 用のドキュメント レベルのプロジェクトにある Sheetn クラスの基底クラスを提供します。

InitializeDataBindings()

Microsoft Office Excel 用のドキュメント レベルのプロジェクトにある Sheetn クラスの基底クラスを提供します。

Move(Object, Object)

ワークシートをブック内の他の場所に移動します。

OLEObjects(Object)

ワークシート上の単一の OLE オブジェクト (OLEObject) または、すべての OLE オブジェクトのコレクション (OLEObjects コレクション) のいずれかを表すオブジェクトを取得します。

OnShutdown()

Microsoft Office Excel 用のドキュメント レベルのプロジェクトにある Sheetn クラスの基底クラスを提供します。

OnStartup()

Microsoft Office Excel 用のドキュメント レベルのプロジェクトにある Sheetn クラスの基底クラスを提供します。

Paste(Object, Object)

クリップボードの内容をワークシートに貼り付けます。

PasteSpecial(Object, Object, Object, Object, Object, Object, Object)

クリップボードの内容を、指定された形式でワークシートに貼り付けます。 他のアプリケーションからデータを貼り付ける場合、または特定の形式でデータを貼り付ける場合、このメソッドを使用します。

PivotTables(Object)

ワークシート上の単一のピボットテーブル レポート (PivotTable オブジェクト) または、すべてのピボットテーブル レポートのコレクション (PivotTables オブジェクト) のいずれかを表すオブジェクトを取得します。

PivotTableWizard(Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object)

PivotTable オブジェクトを作成します。

PrintOutEx(Object, Object, Object, Object, Object, Object, Object, Object, Object)

ワークシートを印刷します。

PrintPreview(Object)

印刷されたときのワークシートのプレビューを示します。

Protect(Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object)

ワークシートを変更できないよう保護します。

ResetAllPageBreaks()

指定されたワークシート上のすべての改ページをリセットします。

SaveAs(String, Object, Object, Object, Object, Object, Object, Object, Object, Object)

ワークシートへの変更を別のファイルに保存します。

Scenarios(Object)

ワークシート上の単一のシナリオ (Scenario オブジェクト) または、シナリオのコレクション (Scenarios オブジェクト) のいずれかを表すオブジェクトを取得します。

Select(Object)

ワークシートを選択します。

SetBackgroundPicture(String)

ワークシートの背景グラフィックを設定します。

ShowAllData()

現在フィルターされたリストのすべての行を表示します。 オートフィルター が使用されている場合、このメソッドは矢印を "すべて" に変更します。

ShowDataForm()

ワークシートに関連付けられたデータ フォームを表示します。

Unprotect(Object)

ワークシートの保護を削除します。 このメソッドは、ワークシートが保護されていないときには何もしません。

XmlDataQuery(String, Object, Object)

特定の XPath にマップされているセルを表す Range オブジェクトを取得します。 指定された XPath がワークシートにマップされていない場合、またはマップされた範囲が空の場合は null を取得します。

XmlMapQuery(String, Object, Object)

特定の XPath にマップされているセルを表す Range オブジェクトを取得します。 指定された XPath がワークシートにマップされていない場合は null を取得します。

イベント

ActivateEvent

ワークシートがアクティブになると発生します。

BeforeDoubleClick

ワークシートがダブルクリックされたとき、既定のダブルクリック処理が行われる前に発生します。

BeforeRightClick

ワークシートが右クリックされたとき、既定の右クリック処理が行われる前に発生します。

BindingContextChanged

Microsoft Office Excel 用のドキュメント レベルのプロジェクトにある Sheetn クラスの基底クラスを提供します。

Calculate

ワークシートが再計算された後で発生します。

Change

WorksheetBase のセルで何か変更があった場合に発生します。

Deactivate

ワークシートがフォーカスを失ったときに発生します。

Disposed

Microsoft Office Excel 用のドキュメント レベルのプロジェクトにある Sheetn クラスの基底クラスを提供します。

FollowHyperlink

ワークシート内のハイパーリンクがクリックされると発生します。

PivotTableAfterValueChange

ピボットテーブル内のセルまたはセル範囲の編集後、または (数式が含まれているセルの) 再計算後に発生します。 このイベントは、Excel 2010 プロジェクトでのみ使用できます。

PivotTableBeforeAllocateChanges

変更がピボットテーブルに適用される前に発生します。 このイベントは、Excel 2010 プロジェクトでのみ使用できます。

PivotTableBeforeCommitChanges

ピボットテーブルの OLAP データ ソースに対して変更がコミットされる前に発生します。 このイベントは、Excel 2010 プロジェクトでのみ使用できます。

PivotTableBeforeDiscardChanges

ピボットテーブルに対する変更が破棄される前に発生します。 このイベントは、Excel 2010 プロジェクトでのみ使用できます。

PivotTableChangeSync

ピボットテーブルに対する変更後に発生します。 このイベントは、Excel 2010 プロジェクトでのみ使用できます。

PivotTableUpdate

ワークシートでピボットテーブル レポートが更新されると発生します。

SelectionChange

ワークシートで選択範囲が変更されると発生します。

Shutdown

ワークシートのホスト項目がシャットダウンすると発生します。

Startup

Microsoft Office Excel 用のドキュメント レベルのプロジェクトにある Sheetn クラスの基底クラスを提供します。

明示的なインターフェイスの実装

EntryPoint.BeginInit()

Microsoft Office Excel 用のドキュメント レベルのプロジェクトにある Sheetn クラスの基底クラスを提供します。

EntryPoint.EndInit()

Microsoft Office Excel 用のドキュメント レベルのプロジェクトにある Sheetn クラスの基底クラスを提供します。

EntryPoint.FinishInitialization()

Microsoft Office Excel 用のドキュメント レベルのプロジェクトにある Sheetn クラスの基底クラスを提供します。

EntryPoint.Initialize()

Microsoft Office Excel 用のドキュメント レベルのプロジェクトにある Sheetn クラスの基底クラスを提供します。

EntryPoint.InitializeDataBindings()

Microsoft Office Excel 用のドキュメント レベルのプロジェクトにある Sheetn クラスの基底クラスを提供します。

EntryPoint.OnShutdown()

Microsoft Office Excel 用のドキュメント レベルのプロジェクトにある Sheetn クラスの基底クラスを提供します。

EntryPoint.OnStartup()

Microsoft Office Excel 用のドキュメント レベルのプロジェクトにある Sheetn クラスの基底クラスを提供します。

IExtension.ExtensionBase

Microsoft Office Excel 用のドキュメント レベルのプロジェクトにある Sheetn クラスの基底クラスを提供します。

IWorksheetExtension.GetAutomationObject()

Microsoft Office Excel 用のドキュメント レベルのプロジェクトにある Sheetn クラスの基底クラスを提供します。

適用対象