syncfusion-dotnet-word について
Syncfusion Word LibraryでWord文書を扱うC#開発者向けのスキルです。プロジェクト用コードの生成と、CSXスクリプトによるタスク実行に対応します。
主な機能
- 01Word処理用C#コードの生成
- 02CSXスクリプトによるタスク実行
- 03文書の作成・編集・変換
- 04メールマージと変更履歴の管理
- 05文書の暗号化と電子署名
活用シーン
- 01C#プロジェクト向けWord処理コードの作成
- 02DOCXファイルの直接作成や編集
- 03Word文書のPDFまたは画像への変換
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ syncfusion/ document-sdk-skills --skill syncfusion-dotnet-wordインストール後、Claude Code で/syncfusion-dotnet-wordを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
README.mdreferences/bookmarks.mdcharts.mdcomments.mdcompare-word-documents.mdcontent-controls.mddigital-signature.mddocument-structure.mdencryption.mdfields.mdfind-and-replace.mdfootnotes-and-endnotes.mdform-fields.mdheader-footer.mdhtml-conversions.mdhyperlinks.mdmacros.mdmail-merge.mdmarkdown-conversion.mdmathematical-equation.mdmerge-word-documents.mdnuget-packages.mdole-object.mdparagraph-and-styles.mdrtf-conversions.mdshapes.mdsmartarts.mdsplit-word-documents.mdstyles-and-formats.mdtable-of-contents.md詳細
Word(DOCX)ドキュメント処理
概要
Syncfusion Word Library を使用して、Word(.docx、.doc)ファイルを作成、編集、変換します。 このスキルでは、ユーザーのプロジェクト用の C# コードを生成するモードと、CSX スクリプトを介してタスクを直接実行するモードの 2 つをサポートしています。
主な機能
- 作成と編集: ドキュメント(.docx、.doc、.rtf、.txt、.xml)、段落、見出し、スタイル、リスト、表、グラフ、図形、画像、ハイパーリンク、ブックマーク、透かし、ヘッダー/フッター、フォームフィールド、コンテンツコントロール、SmartArt、OLE オブジェクト、Word ドキュメントの保存時のフォント埋め込み
- 高度な機能: 差し込み印刷(DataTable、JSON、XML、カスタムオブジェクト)、変更履歴、コメント、数式(LaTeX)、ドキュメントの比較/分割/結合、目次
- 変換: Word から PDF(フォント埋め込み、カスタムフォント登録、PDF/A、アクセシビリティ)、Word から画像(PNG、JPEG、BMP、TIFF、カスタムフォント登録)、HTML ↔ DOCX、RTF ↔ DOCX、テキスト ↔ DOCX、XML ↔ DOCX
- セキュリティ: パスワードによる暗号化/復号、編集可能な範囲を指定したドキュメント保護、マクロ管理、デジタル署名
前提条件
- .NET SDK 8+ および
dotnet-script:dotnet tool install -g dotnet-script - Syncfusion ライセンス:https://www.syncfusion.com/products/communitylicense
クイックスタートの例
例 1:コードを生成する(モード 1)
ユーザー:「表を含む Word ドキュメントを作成する方法を教えてください」
結果: C# コードスニペットを表示(ファイルは作成されません)
例 2:タスクを実行する(モード 2)
ユーザー:「output/report.docx に表を含む Word ドキュメントを作成してください」
結果: 指定したパスに実ファイルを作成
2 つのモード — ユーザーの意図に基づいて選択
モードを選択する前に、ユーザーが何を達成したいのかを推測してください。
モード 1:ユーザーのプロジェクト用の C# コードを生成する (デフォルト)
ユーザーが Word 処理に関連する C# コードを表示、記述、レビュー、リファクタリング、または変更したい場合に、このモードを使用します。
トリガーキーワード: "show me how"、"how to"、"how can I"、"how do I"、"provide code"、"provide an example"、"give an example"、"demonstrate"、"code snippet"、"sample code"、"example"、"sample"、"give me"、"show me"、"Program.cs"、"example code"、"generate code for"、"codesnippet"
ワークフロー:
ステップ 1 — アプリケーションの種類を検出し、適切な NuGet パッケージを提案する
- ワークスペースのプロジェクトファイル(
.csproj、web.config、App.config、Startup.cs、Program.csなど)を確認し、references/nuget-packages.mdの検出シグナル表を使用してアプリケーションの種類を特定します。 - 検出したアプリの種類に基づいて
references/nuget-packages.mdから適切なパッケージを調べ、コードを生成する前にインストールするようユーザーに伝えます。
ステップ 2 — 参照ファイルのみを使ってコードを生成する
参照ファイルに明示的に記載されていない API、メソッド、プロパティ、クラス、名前空間を作り出したり、推測したり、提案したりしないでください。
- 要求された機能に関連する
references/*.mdファイルを読みます - それらのファイルに記載されている API とコードスニペットのみを使用して C# コードを作成します
- ステップ 1 で検出したアプリの種類に基づいて、適切なコードスニペットのバリエーションを選択します:
- Windows 固有のアプリ(WinForms、WPF、.NET Framework Console、ASP.NET MVC5)→ Windows 固有のコードスニペットを使用
- クロスプラットフォームアプリ(ASP.NET Core、.NET Core/.NET 5+ Console、Blazor、MAUI)→ クロスプラットフォーム/
.Net.Coreのコードスニペットを使用
.csxスクリプトを作成または実行しないでください
モード 2:CSX スクリプトで実行する (プロジェクトファイルには触れません)
実行、ファイル生成、または完成済みの Docx ファイルなどの完全に作成された出力をユーザーが明示的に要求した場合に限り、このモードを使用します。
トリガーキーワード: "create a word document"、"make a document"、"generate a document"、"open"、"edit"、"modify"、"change" と .docx ファイルの組み合わせ、"without modifying my project"、"run a csx script"、またはユーザーがファイルパス(例:output/report.docx)を指定した場合。
ワークフロー:
ステップ 1 — 一時 CSX スクリプトを作成する
references/template.csxをベースとして使用します- 作成先:
{skill-root}/syncfusion-dotnet-word/scripts/temp-{uniqueId}.csx(例:skill-root=.codestudio/skills) - 一意のファイル名にはランダムな GUID を使用します(例:
temp-a3f7b2c1.csx)。ワークスペースのルートには作成しないでください
ステップ 2 — 参照ファイルからスクリプトを作成する
- 参照ファイルにない API/メソッドを作り出さないでください
- 関連する
references/*.mdファイルを読み、コードスニペットを抽出します - すべてのプレースホルダー(ファイルパス、ドキュメントのプロパティ、データ値、フィールド名など)を置き換えます
ステップ 3 — スクリプトを実行する
- 実行:
dotnet script {skill-root}/syncfusion-dotnet-word/scripts/temp-{uniqueId}.csx - 実行が成功したことを確認し、エラーがあれば記録します
ステップ 4 — クリーンアップして報告する
- 実行後、一時
.csxファイルを削除します - 出力ファイルのパスと、修正方法を含むエラーメッセージを添えて、SUCCESS/ERROR を報告します
コードリファレンス
すべてのテンプレートとスニペットは references/ フォルダーにあります:
| ファイル | 内容 |
|---|---|
| template.csx | CSX スクリプトの基本構造(モード 2 のみ) |
| document-structure.md | ドキュメントの作成/読み込み、セクションの追加、ページ設定、ファイルまたはストリームへの保存、DOCX 保存時のフォント埋め込み、対応形式 |
| styles-and-formats.md | 段落、見出し、箇条書きリストと番号付きリスト |
| paragraph-and-styles.md | 段落の追加、段落の書式設定、スタイル(組み込み/カスタム)、テキストの書式設定、タブ位置、改行、記号、テキストボックス |
| tables.md | 表の作成、セルの書式設定、セルの結合 |
| bookmarks.md | ブックマークの作成、移動、取得、コンテンツの挿入/置換/削除、ブックマーク末尾の位置指定オプション |
| charts.md | 一から、または Excel からのグラフ作成、データの変更、更新、要素のカスタマイズ、3D 書式設定、画像への変換 |
| shapes.md | 図形の追加、書式設定、回転、グループ化、グループ解除 |
| mail-merge.md | 単純なフィールドの差し込み、領域(グループ)を使用した差し込み、入れ子の差し込み、DataTable、動的オブジェクト、ビジネスオブジェクト、DataView、XML、JSON、画像差し込みフィールド、差し込みイベント(MergeField、MergeImageField、BeforeClearField、BeforeClearGroupField)、フィールドのマッピング、差し込みフィールド名の取得、空の段落の削除、フィールドをクリアするオプション |
| form-fields.md | チェックボックス、ドロップダウン、テキスト入力フィールドの追加、プロパティの変更 |
| macros.md | マクロ有効ドキュメント(DOTM、DOCM)の読み込み/保存、マクロの確認、マクロの削除、変換時のマクロの保持 |
| mathematical-equation.md | 数式の作成(分数、根号、行列、N 配列など)、既存の数式の変更、LaTeX 対応、数式の書式設定 |
| split-word-documents.md | セクション、見出し、ブックマーク、プレースホルダーテキストによるドキュメントの分割 |
| merge-word-documents.md | 新しいページまたは同じページでのドキュメントの結合、インポートしたリストのスタイルの維持 |
| table-of-contents.md | 目次の追加、更新、スイッチの適用、カスタムスタイル、図表目次、目次の削除 |
| compare-word-documents.md | 2 つの Word ドキュメントの比較、作成者と日付の設定、比較オプション、書式の変更の無視 |
| html-conversions.md | HTML から DOCX への変換、DOCX から HTML への変換、XHTML の検証、画像のカスタマイズ(インポート/エクスポート)、CSS セレクター、エクスポートオプション、ヘッダー/フッターのエクスポート |
| rtf-conversions.md | RTF から DOCX への変換、DOCX から RTF への変換、書式とコンテンツの保持 |
| markdown-conversion.md | Markdown から DOCX への変換、DOCX から Markdown への変換、画像のカスタマイズ、CommonMark と GitHub 形式の構文への対応 |
| text-conversions.md | Text から DOCX への変換、DOCX から Text への変換、プレーンテキストの抽出、テキストコンテンツの保持 |
| xml-conversions.md | Word から XML(WordML)への変換、XML から Word への変換、Word Processing XML 形式(2007 以降) |
| word-to-pdf.md | DOCX から PDF への変換、フォントの埋め込み、カスタムフォントの登録、PDF/A 準拠、アクセシブルな PDF、フォームフィールドの保持、フォントの置換、スクリプトの種類と Unicode 範囲に応じた代替フォント |
| word-to-image.md | DOCX から画像への変換、カスタムフォントの登録、特定のページまたはページ範囲の画像への変換 |
| word-to-odt.md | Word から ODT への変換、書式とコンテンツの保持、対応するドキュメント要素、テキストの書式設定 |
| encryption.md | パスワードによる暗号化、暗号化されたドキュメントを開く、暗号化の解除、編集の保護、編集可能な範囲 |
| digital-signature.md | 非表示のデジタル署名の追加、1 つまたは複数の表示署名欄の挿入と署名、署名標準の指定、署名の検証、確認、削除。コード例はクロスプラットフォームアプリと Windows 専用アプリで共通です |
| watermark.md | テキストと画像の透かし、透かしのレイアウト、拡大縮小、淡色表示効果、透かしの削除 |
| find-and-replace.md | Find/FindAll/FindNext、Replace(文字列/正規表現)、ReplaceSingleLine、FindItem* API |
| footnotes-and-endnotes.md | 脚注と文末脚注の追加、位置の設定(ページ下部/セクション末尾)、番号形式、区切り線、コンテンツの変更、脚注と文末脚注の削除 |
| track-changes.md | 変更履歴の有効化/無効化、変更の承諾/拒否、レビュー担当者によるフィルター、リビジョン情報 |
| comments.md | コメントの追加/変更/削除、特定のテキストへの挿入、親コメントへのアクセス、コメントが付いた項目の取得 |
| content-controls.md | ブロック型およびインライン型コンテンツコントロール、種類(リッチテキスト、プレーンテキスト、チェックボックス、日付、ドロップダウン、画像)、プロパティ、保護、フォーム入力、XML マッピング |
| header-footer.md | ヘッダーとフッターの追加/削除、フィールド(日付、時刻)を使用したページ番号、奇数/偶数ページ、先頭ページを別に設定、枠線、画像、前のセクションへのリンク |
| hyperlinks.md | Web ハイパーリンク、メールハイパーリンク、ファイルハイパーリンク、ブックマークハイパーリンク、画像ハイパーリンク、ハイパーリンクの変更 |
| ole-object.md | OLE オブジェクトの埋め込み、OLE オブジェクトのファイルへの抽出、OLE オブジェクトの削除、オブジェクトの種類 |
| smartarts.md | SmartArt レイアウトの作成、ノードの追加/変更、外観の変更、アシスタントノード、SmartArt の削除 |
ルール
- 出力ファイルは
./output/ディレクトリに保存します - 一時的な
.csxスクリプトは{skill-root}/syncfusion-dotnet-word/scripts/内に作成する必要があります。ワークスペースのルートや顧客のscripts/フォルダーには作成しないでください - Python ライブラリ(例:python-docx)は使用しないでください
- 実行後、一時的な
.csxファイルを残さないでください