Visio.HyperlinkCollection class
ハイパーリンク コレクションを表します。
- Extends
注釈
[ API セット: 1.1 ]
プロパティ
context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
items | このコレクション内に読み込まれた子アイテムを取得します。 |
メソッド
get |
ハイパーリンクの数を取得します。 |
get |
そのキー (名前または ID) を使用してハイパーリンクを取得します。 |
load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
set |
モック データを設定する |
toJSON() | API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;
プロパティ値
items
メソッドの詳細
getCount()
ハイパーリンクの数を取得します。
getCount(): OfficeExtension.ClientResult<number>;
戻り値
OfficeExtension.ClientResult<number>
注釈
[ API セット: 1.1 ]
getItem(Key)
そのキー (名前または ID) を使用してハイパーリンクを取得します。
getItem(Key: number | string): Visio.Hyperlink;
パラメーター
- Key
-
number | string
キーは、取得するハイパーリンクの名前またはインデックスです。
戻り値
注釈
[ API セット: 1.1 ]
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync()
を呼び出す必要があります。
load(options?: Visio.Interfaces.HyperlinkCollectionLoadOptions & Visio.Interfaces.CollectionLoadOptions): Visio.HyperlinkCollection;
パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
例
Visio.run(session, function (ctx) {
const activePage = ctx.document.getActivePage();
const shapeName = "Manager Belt";
const shape = activePage.shapes.getItem(shapeName);
const shapeHyperlinks = shape.hyperlinks;
shapeHyperlinks.load(["description", "address", "subAddress"]);
ctx.sync().then(function () {
for (let i = 0; i < shapeHyperlinks.items.length; i++) {
const hyperlink = shapeHyperlinks.items[i];
console.log(
"Description:"+hyperlink.description +"Address:"+hyperlink.address +"SubAddress: " +
hyperlink.subAddress);
}
});
}).catch(function(error) {
console.log("Error: " + error);
if (error instanceof OfficeExtension.Error) {
console.log("Debug info: " + JSON.stringify(error.debugInfo));
}
});
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync()
を呼び出す必要があります。
load(propertyNames?: string | string[]): Visio.HyperlinkCollection;
パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync()
を呼び出す必要があります。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Visio.HyperlinkCollection;
パラメーター
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select
は、読み込むプロパティを指定するコンマ区切り文字列で propertyNamesAndPaths.expand
、読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
setMockData(data)
モック データを設定する
setMockData(data: Visio.Interfaces.HyperlinkCollectionData): void;
パラメーター
戻り値
void
toJSON()
API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript toJSON()
メソッドを JSON.stringify()
オーバーライドします。 (JSON.stringify
さらに、渡される オブジェクトの メソッドを呼び出 toJSON
します)。元 Visio.HyperlinkCollection
のオブジェクトは API オブジェクトですが、 toJSON
メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト (として Visio.Interfaces.HyperlinkCollectionData
型指定) を返します。
toJSON(): Visio.Interfaces.HyperlinkCollectionData;
戻り値
Office Add-ins
フィードバック
https://aka.ms/ContentUserFeedback」を参照してください。
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「フィードバックの送信と表示