このトピックでは、スプレッドシートドキュメントの AllowEditRanges 機能に関連する API 操作について説明します。
Alloweditranges
ActiveWorkbook.ActiveSheet.AllowEditRanges
アクティブなワークブックのアクティブなワークシート内の編集可能範囲を取得します。
構文
expression.ActiveWorkbook.ActiveSheet.AllowEditRangesexpression: ドキュメントタイプのアプリケーションオブジェクト。
例
async function example() { await instance.ready(); const app = instance.Application; // アクティブなワークブックのアクティブなワークシートを取得します。 const activeSheet = await app.ActiveWorkbook.ActiveSheet; // アクティブなワークシート内の編集可能範囲を取得します。 const allowEditRanges = await activeSheet.AllowEditRanges; }
メソッド
ActiveWorkbook.ActiveSheet.AllowEditRanges.Add()
Add() メソッドを使用して、アクティブなワークシートに編集可能範囲を追加できます。
構文
expression.ActiveWorkbook.ActiveSheet.AllowEditRanges.Add({ Title, Range, Password })expression: ドキュメントタイプのアプリケーションオブジェクト。
パラメータ
パラメータ
データ型
必須
説明
Range
Object
はい
範囲。
Title
String
いいえ
タイトル。
Password
String
いいえ
アクティブなワークシートのパスワード。
例
async function example() { await instance.ready(); const app = instance.Application; // アクティブなワークブックのアクティブなワークシートを取得します。 const activeSheet = await app.ActiveWorkbook.ActiveSheet; // アクティブなワークシート内の編集可能範囲を取得します。 const allowEditRanges = await activeSheet.AllowEditRanges; // 左上隅から A1、右下隅から E20 までの範囲を選択します。 const range = await activeSheet.Range('$A1:$E20'); // 編集可能範囲を追加します。 await allowEditRanges.Add(undefined, range, 'Aliyun'); }
プロパティ
ActiveWorkbook.ActiveSheet.AllowEditRanges.Count
JavaScript V1.1.19 以降の SDK のみでこの機能がサポートされています。
Count プロパティを使用して、保護されたワークシート内の編集可能範囲の数を取得できます。
構文
expression.ActiveWorkbook.ActiveSheet.AllowEditRanges.Countexpression: ドキュメントタイプのアプリケーションオブジェクト。
例
async function example() { await instance.ready(); const app = instance.Application; // アクティブなワークブックのアクティブなワークシートを取得します。 const activeSheet = await app.ActiveWorkbook.ActiveSheet; // 編集可能範囲。 const allowEditRanges = await activeSheet.AllowEditRanges; // 編集可能範囲の数。 const count = await allowEditRanges.Count; }
Alloweditrange
ActiveWorkbook.ActiveSheet.AllowEditRanges.Item()
アクティブなワークシート内の編集可能範囲のアイテムを取得します。
JavaScript V1.1.19 以降の SDK のみでこの機能がサポートされています。
構文
expression.ActiveWorkbook.ActiveSheet.AllowEditRanges.Item(Index)expression: ドキュメントタイプのアプリケーションオブジェクト。
パラメータ
パラメータ
データ型
必須
説明
Index
Variant
はい
オブジェクトのインデックス。
例
async function example() { await instance.ready(); const app = instance.Application; // アクティブなワークブックのアクティブなワークシートを取得します。 const activeSheet = await app.ActiveWorkbook.ActiveSheet; // 編集可能範囲。 const allowEditRanges = await activeSheet.AllowEditRanges; const item = await allowEditRanges.Item(1); }
メソッド
ActiveWorkbook.ActiveSheet.AllowEditRanges.Item().Delete()
Delete() メソッドを使用して、保護されたワークシート内の編集可能範囲のアイテムを削除できます。
JavaScript V1.1.19 以降の SDK のみでこの機能がサポートされています。
構文
expression.ActiveWorkbook.ActiveSheet.AllowEditRanges.Item(Index).Delete()expression: ドキュメントタイプのアプリケーションオブジェクト。
パラメータ
パラメータ
データ型
必須
説明
Password
Variant
はい
保護されたワークシートのパスワード
例
async function example() { await instance.ready(); const app = instance.Application; // アクティブなワークブックのアクティブなワークシートを取得します。 const activeSheet = await app.ActiveWorkbook.ActiveSheet; // 編集可能範囲。 const allowEditRanges = await activeSheet.AllowEditRanges; const item = await allowEditRanges.Item(1); await item.Delete('123'); }
ActiveWorkbook.ActiveSheet.AllowEditRanges.Item().AddUser()
AddUser() メソッドを使用して、保護されたワークシート内の編集可能範囲のアイテムにユーザーを追加できます。
JavaScript V1.1.19 以降の SDK のみでこの機能がサポートされています。
構文
expression.ActiveWorkbook.ActiveSheet.AllowEditRanges.Item(Index).AddUser()expression: ドキュメントタイプのアプリケーションオブジェクト。
パラメータ
パラメータ
データ型
必須
説明
Password
Variant
はい
保護されたワークシートのパスワード
UserId
Variant
はい
ユーザー ID。
例
async function example() {
await instance.ready();
const app = instance.Application;
// アクティブなワークブックのアクティブなワークシートを取得します。
const activeSheet = await app.ActiveWorkbook.ActiveSheet;
// 編集可能範囲。
const allowEditRanges = await activeSheet.AllowEditRanges;
const item = await allowEditRanges.Item(1);
// ユーザーを追加します。
await item.AddUser({Password:'', UserId:'280289376'});
}ActiveWorkbook.ActiveSheet.AllowEditRanges.Item().RemoveUser()
RemoveUser() メソッドを使用して、保護されたワークシート内の編集可能範囲のアイテムからユーザーを削除できます。
JavaScript V1.1.19 以降の SDK のみでこの機能がサポートされています。
構文
expression.ActiveWorkbook.ActiveSheet.AllowEditRanges.Item(Index).RemoveUser()expression: ドキュメントタイプのアプリケーションオブジェクト。
パラメータ
パラメータ
データ型
必須
説明
Password
Variant
はい
保護されたワークシートのパスワード。
UserId
Variant
はい
ユーザー ID。
例
async function example() { await instance.ready(); const app = instance.Application; // アクティブなワークブックのアクティブなワークシートを取得します。 const activeSheet = await app.ActiveWorkbook.ActiveSheet; // 編集可能範囲。 const allowEditRanges = await activeSheet.AllowEditRanges; const item = await allowEditRanges.Item(1); // ユーザーを削除します。 await item.RemoveUser({Password:'', UserId:'280289376'}); }
プロパティ
ActiveWorkbook.ActiveSheet.AllowEditRanges.Item().Range
Range プロパティを使用して、保護されたワークシート内の編集可能範囲のアイテムの選択範囲を取得できます。
JavaScript V1.1.19 以降の SDK のみでこの機能がサポートされています。
構文
expression.ActiveWorkbook.ActiveSheet.AllowEditRanges.Item(Index).Rangeexpression: ドキュメントタイプのアプリケーションオブジェクト。
例
async function example() { await instance.ready(); const app = instance.Application; // アクティブなワークブックのアクティブなワークシートを取得します。 const activeSheet = await app.ActiveWorkbook.ActiveSheet; // 編集可能範囲。 const allowEditRanges = await activeSheet.AllowEditRanges; const item = await allowEditRanges.Item(1); await item.Range; }
ActiveWorkbook.ActiveSheet.AllowEditRanges.Item().Users
Users プロパティを使用して、保護されたワークシート内の編集可能範囲のアイテムのユーザーを取得できます。
JavaScript V1.1.19 以降の SDK のみでこの機能がサポートされています。
構文
expression.ActiveWorkbook.ActiveSheet.AllowEditRanges.Item(Index).Usersexpression: ドキュメントタイプのアプリケーションオブジェクト。
例
async function example() { await instance.ready(); const app = instance.Application; // アクティブなワークブックのアクティブなワークシートを取得します。 const activeSheet = await app.ActiveWorkbook.ActiveSheet; // 編集可能範囲。 const allowEditRanges = await activeSheet.AllowEditRanges; const item = await allowEditRanges.Item(1); // 編集可能範囲のユーザーを取得します。 await item.Users; }