Excel.RequestContext class
The RequestContext object facilitates requests to the Excel application. Since the Office add-in and the Excel application run in two different processes, the request context is required to get access to the Excel object model from the add-in.
Remarks
Used by
- Excel: run
- Excel.Application: context
- Excel.Binding: context
- Excel.BindingCollection: context
- Excel.Chart: context
- Excel.ChartAreaFormat: context
- Excel.ChartAxes: context
- Excel.ChartAxis: context
- Excel.ChartAxisFormat: context
- Excel.ChartAxisTitle: context
- Excel.ChartAxisTitleFormat: context
- Excel.ChartCollection: context
- Excel.ChartDataLabelFormat: context
- Excel.ChartDataLabels: context
- Excel.ChartFill: context
- Excel.ChartFont: context
- Excel.ChartGridlines: context
- Excel.ChartGridlinesFormat: context
- Excel.ChartLegend: context
- Excel.ChartLegendFormat: context
- Excel.ChartLineFormat: context
- Excel.ChartPoint: context
- Excel.ChartPointFormat: context
- Excel.ChartPointsCollection: context
- Excel.ChartSeries: context
- Excel.ChartSeriesCollection: context
- Excel.ChartSeriesFormat: context
- Excel.ChartTitle: context
- Excel.ChartTitleFormat: context
- Excel.Filter: context
- Excel.FormatProtection: context
- Excel.FunctionResult: context
- Excel.Functions: context
- Excel.NamedItem: context
- Excel.NamedItemCollection: context
- Excel.PivotTable: context
- Excel.PivotTableCollection: context
- Excel.Range: context
- Excel.RangeBorder: context
- Excel.RangeBorderCollection: context
- Excel.RangeFill: context
- Excel.RangeFont: context
- Excel.RangeFormat: context
- Excel.RangeSort: context
- Excel.RangeView: context
- Excel.RangeViewCollection: context
- Excel.Setting: context
- Excel.SettingCollection: context
- Excel.Table: context
- Excel.TableCollection: context
- Excel.TableColumn: context
- Excel.TableColumnCollection: context
- Excel.TableRow: context
- Excel.TableRowCollection: context
- Excel.TableSort: context
- Excel.Workbook: context
- Excel.Worksheet: context
- Excel.WorksheetCollection: context
- Excel.WorksheetProtection: context
Examples
// *.run methods automatically create an OfficeExtension.ClientRequestContext
// object to work with the Office file.
await Excel.run(async (context: Excel.RequestContext) => {
const workbook = context.workbook;
// Interact with the Excel workbook...
});
Constructors
| (constructor)(url) | Constructs a new instance of the |
Properties
| application | |
| workbook |
Constructor Details
(constructor)(url)
Constructs a new instance of the RequestContext class
constructor(url?: string | Session);
Parameters
- url
-
string | Excel.Session