Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions docs/docs-ref-autogen/common/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -291,10 +291,6 @@ items:
href: ../../manifest/disableentityhighlighting.md
- name: DisplayName
href: ../../manifest/displayname.md
- name: EquivalentAddin
href: ../../manifest/equivalentaddin.md
- name: EquivalentAddins
href: ../../manifest/equivalentaddins.md
- name: ExtendedOverrides
href: ../../manifest/extendedoverrides.md
- name: FileName
Expand Down
4 changes: 0 additions & 4 deletions docs/docs-ref-autogen/common_preview/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -293,10 +293,6 @@ items:
href: ../../manifest/disableentityhighlighting.md
- name: DisplayName
href: ../../manifest/displayname.md
- name: EquivalentAddin
href: ../../manifest/equivalentaddin.md
- name: EquivalentAddins
href: ../../manifest/equivalentaddins.md
- name: ExtendedOverrides
href: ../../manifest/extendedoverrides.md
- name: FileName
Expand Down
30 changes: 29 additions & 1 deletion docs/docs-ref-autogen/excel/excel/excel.cellcontroltype.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,35 @@ uid: 'excel!Excel.CellControlType:enum'
package: excel!
fullName: Excel.CellControlType
summary: Represents the type of cell control.
remarks: '\[ [API set: ExcelApi 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
remarks: >-
\[ [API set: ExcelApi 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]


#### Examples


```TypeScript

// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml


// Add checkboxes to the table.

await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getActiveWorksheet();

// Get the second column in the table, without the header.
const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange();

// Change the boolean values to checkboxes.
range.control = {
type: Excel.CellControlType.checkbox
};
await context.sync();
});

```
isPreview: false
isDeprecated: false
fields:
Expand Down
30 changes: 29 additions & 1 deletion docs/docs-ref-autogen/excel/excel/excel.checkboxcellcontrol.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,35 @@ uid: 'excel!Excel.CheckboxCellControl:interface'
package: excel!
fullName: Excel.CheckboxCellControl
summary: Represents a checkbox. This is a cell control that allows a user to toggle the boolean value in a cell.
remarks: '\[ [API set: ExcelApi 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
remarks: >-
\[ [API set: ExcelApi 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]


#### Examples


```TypeScript

// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml


// Add checkboxes to the table.

await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getActiveWorksheet();

// Get the second column in the table, without the header.
const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange();

// Change the boolean values to checkboxes.
range.control = {
type: Excel.CellControlType.checkbox
};
await context.sync();
});

```
isPreview: false
isDeprecated: false
type: interface
Expand Down
8 changes: 4 additions & 4 deletions docs/docs-ref-autogen/excel/excel/excel.comment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ properties:
```TypeScript

// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-basics.yaml
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/comment-basics.yaml


await Excel.run(async (context) => {
Expand Down Expand Up @@ -156,7 +156,7 @@ properties:
```TypeScript

// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-resolution.yaml
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/comment-resolution.yaml


await Excel.run(async (context) => {
Expand Down Expand Up @@ -221,7 +221,7 @@ methods:
```TypeScript

// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-basics.yaml
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/comment-basics.yaml


await Excel.run(async (context) => {
Expand Down Expand Up @@ -329,7 +329,7 @@ methods:
```TypeScript

// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-basics.yaml
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/comment-basics.yaml


await Excel.run(async (context) => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ methods:
```TypeScript

// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-basics.yaml
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/comment-basics.yaml


await Excel.run(async (context) => {
Expand Down
4 changes: 2 additions & 2 deletions docs/docs-ref-autogen/excel/excel/excel.commentreply.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ properties:
```TypeScript

// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-replies.yaml
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/comment-replies.yaml


await Excel.run(async (context) => {
Expand Down Expand Up @@ -194,7 +194,7 @@ methods:
```TypeScript

// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-replies.yaml
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/comment-replies.yaml


await Excel.run(async (context) => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ methods:
```TypeScript

// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-replies.yaml
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/comment-replies.yaml


await Excel.run(async (context) => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ properties:
```TypeScript

// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-mentions.yaml
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/comment-mentions.yaml


await Excel.run(async (context) => {
Expand Down
2 changes: 1 addition & 1 deletion docs/docs-ref-autogen/excel/excel/excel.contenttype.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ remarks: >-
```TypeScript

// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-mentions.yaml
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/comment-mentions.yaml


await Excel.run(async (context) => {
Expand Down
151 changes: 145 additions & 6 deletions docs/docs-ref-autogen/excel/excel/excel.note.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,30 @@ uid: 'excel!Excel.Note:class'
package: excel!
fullName: Excel.Note
summary: Represents a note in the workbook or worksheet.
remarks: '\[ [API set: ExcelApi 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
remarks: >-
\[ [API set: ExcelApi 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]


#### Examples


```TypeScript

// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/excel-note-basics.yaml


// This function changes the height and width of the first note.

await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Notes");
const note = sheet.notes.getItemAt(0);
note.height = 200;
note.width = 400;
await context.sync();
});

```
isPreview: false
isDeprecated: false
type: class
Expand All @@ -26,7 +49,29 @@ properties:
package: excel!
fullName: content
summary: Gets or sets the text of the note.
remarks: '\[ [API set: ExcelApi 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
remarks: >-
\[ [API set: ExcelApi 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]


#### Examples


```TypeScript

// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/excel-note-basics.yaml


// This function changes the content in the first note.

await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Notes");
const note = sheet.notes.getItemAt(0);
note.content = "Changing the content of the first note.";
await context.sync();
});

```
isPreview: false
isDeprecated: false
syntax:
Expand All @@ -52,7 +97,30 @@ properties:
package: excel!
fullName: height
summary: Specifies the height of the note.
remarks: '\[ [API set: ExcelApi 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
remarks: >-
\[ [API set: ExcelApi 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]


#### Examples


```TypeScript

// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/excel-note-basics.yaml


// This function changes the height and width of the first note.

await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Notes");
const note = sheet.notes.getItemAt(0);
note.height = 200;
note.width = 400;
await context.sync();
});

```
isPreview: false
isDeprecated: false
syntax:
Expand All @@ -64,7 +132,32 @@ properties:
package: excel!
fullName: visible
summary: Specifies the visibility of the note. A value of `true` means the note is shown.
remarks: '\[ [API set: ExcelApi 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
remarks: >-
\[ [API set: ExcelApi 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]


#### Examples


```TypeScript

// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/excel-note-basics.yaml


// This function sets the note on cell A1 to visible.

await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Notes");
const firstNote = sheet.notes.getItem("A1");

firstNote.load();
await context.sync();

firstNote.visible = true;
});

```
isPreview: false
isDeprecated: false
syntax:
Expand All @@ -76,7 +169,30 @@ properties:
package: excel!
fullName: width
summary: Specifies the width of the note.
remarks: '\[ [API set: ExcelApi 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
remarks: >-
\[ [API set: ExcelApi 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]


#### Examples


```TypeScript

// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/excel-note-basics.yaml


// This function changes the height and width of the first note.

await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Notes");
const note = sheet.notes.getItemAt(0);
note.height = 200;
note.width = 400;
await context.sync();
});

```
isPreview: false
isDeprecated: false
syntax:
Expand All @@ -89,7 +205,30 @@ methods:
package: excel!
fullName: delete()
summary: Deletes the note.
remarks: '\[ [API set: ExcelApi 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
remarks: >-
\[ [API set: ExcelApi 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]


#### Examples


```TypeScript

// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/excel-note-basics.yaml


// This function deletes the note from cell A2.

await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Notes");
const note = sheet.notes.getItem("A2");
note.delete();

await context.sync();
});

```
isPreview: false
isDeprecated: false
syntax:
Expand Down
Loading
Loading