Class SpreadsheetWriteTool
A built-in tool for writing values to cells in an existing Excel (.xlsx) file.
Accepts an array of cell writes, each specifying a cell address and value or formula. The file must already exist; use SpreadsheetCreateTool to create new files.
public sealed class SpreadsheetWriteTool : IBuiltInTool, ITool, IToolMetadata
- Inheritance
-
SpreadsheetWriteTool
- Implements
- Inherited Members
Examples
var options = new SpreadsheetToolOptions { AllowWrite = true };
var writeTool = new SpreadsheetWriteTool(options);
var result = await writeTool.InvokeAsync(@"{""path"":""report.xlsx"",""cells"":[{""cell"":""A1"",""value"":""Hello""},{""cell"":""B1"",""value"":42}]}");
Constructors
- SpreadsheetWriteTool()
Initializes a new instance with default options.
- SpreadsheetWriteTool(SpreadsheetToolOptions)
Initializes a new instance with the specified options.
Properties
- Description
Gets a concise description of what the tool does.
- InputSchema
Gets the JSON Schema defining the expected input arguments.
- Name
Gets the stable, unique identifier for this tool.
Methods
- InvokeAsync(string, CancellationToken)
Executes the tool with the specified JSON arguments.