Partager via

Excel.Note class

  • Référence
Paquet:
excel

Représente une note dans le classeur ou la feuille de calcul.

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : ExcelApi 1.18 ]

Propriétés

authorName

Obtient l’auteur de la note.
content

Obtient ou définit le texte de la note.
context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
height

Spécifie la hauteur de la note.
visible

Spécifie la visibilité de la note. La valeur signifie true que la note est affichée.
width

Spécifie la largeur de la note.

Méthodes

delete()

Supprime la note.
getLocation()

Obtient la cellule où se trouve cette note.
load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.
set(properties)

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.
toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.Note est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.NoteDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

Détails de la propriété

authorName

Obtient l’auteur de la note.

readonly authorName: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.18 ]

content

Obtient ou définit le texte de la note.

content: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.18 ]

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Excel.RequestContext

height

Spécifie la hauteur de la note.

height: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi 1.18 ]

visible

Spécifie la visibilité de la note. La valeur signifie true que la note est affichée.

visible: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.18 ]

width

Spécifie la largeur de la note.

width: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi 1.18 ]

Détails de la méthode

delete()

Supprime la note.

delete(): void;

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.18 ]

getLocation()

Obtient la cellule où se trouve cette note.

getLocation(): Excel.Range;

Retours

Excel.Range

Remarques

[ Ensemble d’API : ExcelApi 1.18 ]

load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: Excel.Interfaces.NoteLoadOptions): Excel.Note;

Paramètres

options
Excel.Interfaces.NoteLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Excel.Note

load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames?: string | string[]): Excel.Note;

Paramètres

propertyNames

string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.

Retours

Excel.Note

load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Note;

Paramètres

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

Excel.Note

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.

set(properties: Interfaces.NoteUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties
Excel.Interfaces.NoteUpdateData

Objet JavaScript avec des propriétés qui sont structurées isomorphes en fonction des propriétés de l’objet sur lequel la méthode est appelée.

options
OfficeExtension.UpdateOptions

Fournit une option permettant de supprimer les erreurs si l’objet properties tente de définir des propriétés en lecture seule.

Retours

void

set(properties)

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Excel.Note): void;

Paramètres

properties
Excel.Note

Retours

void

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.Note est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.NoteDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Excel.Interfaces.NoteData;

Retours

Excel.Interfaces.NoteData