ScTableSheetsObjは、OpenOffice.org Calc テーブルシートの集合を表すオブジェクトである。

プロパティの概要

ScTableSheetsObj のプロパティ一覧を次に示す。

プロパティ 概要
SbxOBJECT ElementType
SbxARRAY ElementNames
SbxLONG Count
SbxSTRING ImplementationName
SbxARRAY SupportedServiceNames
SbxARRAY Types
SbxARRAY ImplementationId
SbxSTRING Dbg_SupportedInterfaces サポートしているインタフェースの一覧
SbxSTRING Dbg_Properties 属性の一覧
SbxSTRING Dbg_Methods メソッドの一覧

メソッドの概要

ScTableSheetsObj のメソッド一覧を次に示す。

メソッド 概要
SbxEMPTY queryInterface ( SbxOBJECT )
SbxOBJECT getElementType ( void )
SbxBOOL hasElements ( void )
SbxEMPTY getByName ( SbxSTRING ) テーブルシートオブジェクトへの参照を返す(名前で指定)
SbxARRAY getElementNames ( void )
SbxBOOL hasByName ( SbxSTRING ) テーブルシートが存在するか否かを返す
SbxVOID replaceByName ( SbxSTRING, SbxVARIANT )
SbxVOID insertByName ( SbxSTRING, SbxVARIANT )
SbxVOID removeByName ( SbxSTRING ) テーブルシートを削除する
SbxVOID insertNewByName ( SbxSTRING, SbxINTEGER ) 新たにテーブルシートを挿入する
SbxVOID moveByName ( SbxSTRING, SbxINTEGER )
SbxVOID copyByName ( SbxSTRING, SbxSTRING, SbxINTEGER )
SbxOBJECT getCellByPosition ( SbxLONG, SbxLONG, SbxLONG )
SbxOBJECT getCellRangeByPosition ( SbxLONG, SbxLONG, SbxLONG, SbxLONG, SbxLONG )
SbxARRAY getCellRangesByName ( SbxSTRING )
SbxOBJECT createEnumeration ( void )
SbxLONG getCount ( void ) テーブルシートの数を返す
SbxEMPTY getByIndex ( SbxLONG ) テーブルシートオブジェクトへの参照を返す(番号で指定)
SbxSTRING getImplementationName ( void )
SbxBOOL supportsService ( SbxSTRING )
SbxARRAY getSupportedServiceNames ( void )
SbxARRAY getTypes ( void )
SbxARRAY getImplementationId ( void )
SbxOBJECT queryAdapter ( void )

メソッドの詳細

getByIndex

getByIndexメソッドは、指定したインデックス番号の表(シート)オブジェクトを返す。

呼び出し形式
SbxEMPTY getByIndex(SbxLONG)

OpenOffice.org Basic での呼び出し形式:

Function getByIndex( index As Long) As Object
戻り値

表(シート)オブジェクトを返す。

引数
index
オブジェクトを取得する表(シート)のインデックス番号

表(シート)には左から順番に0から始まるインデックス番号が付けられている。

使用例
Dim oSheet As Object
oSheet = ThisComponent.Sheets.getByIndex(0)

getByName

getByNameメソッドは、指定した名前の表(シート)オブジェクトを返す。

呼び出し形式
SbxEMPTY getByName(SbxSTRING)

OpenOffice.org Basic での呼び出し形式:

Function getByName( name As String) As Object
戻り値

表(シート)オブジェクトを返す。

引数
name
オブジェクトを取得する表(シート)の名前
使用例
Dim oSheet As Object

oSheet = ThisComponent.Sheets.getByName("表1")

getCount

ggetCountメソッドは、ドキュメントに含まれる表(シート)の数を返す。

呼び出し形式
SbxLONG getCount(void)

OpenOffice.org Basic での呼び出し形式:

Function getCount As Long
戻り値

ドキュメントに含まれる表(シート)の数を返す。

引数

無し

使用例
Dim count As Long

count = ThisComponent.Sheets.getCount

hasByName

hasByNameメソッドは、指定した名前の表(シート)が存在するか否かを判定する。

呼び出し形式
SbxBOOL hasByName(SbxSTRING)

OpenOffice.org Basic での呼び出し形式:

Function hasByName( name As String) As Boolean
戻り値

指定された名前の表(シート)が存在すればTrue、存在しなれけばFalseを返す。

引数
name
存在の有無を確認する表(シート)の名前
使用例
Dim oSheet As Object

If ThisComponent.Sheets.hasByName("表1") = True Then
    oSheet = ThisComponent.Sheets.getByName("表1")
End If

insertNewByName

insertNewByNameメソッドは、ドキュメントに新しい表(シート)を挿入する。

呼び出し形式
SbxVOID insertNewByName(SbxSTRING, SbxINTEGER)

OpenOffice.org Basic での呼び出し形式:

Sub insertNewByName( name As String, index As Integer)
戻り値

無し

引数
name
ドキュメントに挿入する新しい表(シート)の名前
index
ドキュメントに挿入する新しい表(シート)のインデックス番号

表(シート)には左から順番に0から始まるインデックス番号が付けられている。

使用例
Dim index As Integer

index = ThisComponent.Sheets.getCount
If ThisComponent.Sheets.hasByName("新しい表") = False Then
    ThisComponent.Sheets.insertNewByName("新しい表", index)
End If

removeByName

removeByNameメソッドは、指定した名前の表(テーブルシート)を削除する。

呼び出し形式
SbxVOID removeByName(SbxSTRING)

OpenOffice.org Basic での呼び出し形式:

Sub removeByName( name As String)
戻り値

無し

引数
name
削除する表(テーブルシート)の名前
使用例
If ThisComponent.Sheets.hasByName("表1") = True Then
    ThisComponent.Sheets.removeByName("表1")
End If