OneNote.Image class
Stellt ein Bild dar. Ein Bild kann ein direkt untergeordnetes Element eines PageContent-Objekts oder eines Paragraph-Objekts sein.
- Extends
Hinweise
Eigenschaften
| context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| description | Dient zum Abrufen oder Festlegen der Beschreibung des Bilds. |
| height | Dient zum Abrufen oder Festlegen der Höhe des Bildlayouts. |
| hyperlink | Dient zum Abrufen oder Festlegen des Hyperlinks des Bilds. |
| id | Ruft die ID des Image-Objekts ab. |
| ocr |
Ruft die von OCR (Optical Character Recognition) dieses Bilds abgerufenen Daten ab, z. B. OCR-Text und -Sprache. |
| page |
Ruft das PageContent-Objekt ab, das das Bild enthält. Wird ausgelöst, wenn das Bild nicht ein direkt untergeordnetes Element eines PageContent-Objekts ist. Dieses Objekt definiert die Position des Bilds auf der Seite. |
| paragraph | Ruft das Paragraph-Objekt ab, das das Bild enthält. Löst aus, wenn das Bild kein direktes untergeordnetes Element eines Absatzes ist. |
| width | Dient zum Abrufen oder Festlegen der Breite des Bildlayouts. |
Methoden
| get |
Ruft die base64-verschlüsselte binäre Darstellung des Bilds ab. Beispiel: data:image/png; base64,iVBORw0KGgoAAAANSUhEUgAAADIA... |
| load(options) | Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| set(properties, options) | Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben. |
| set(properties) | Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt. |
| toJSON() | Überschreibt die JavaScript-Methode |
| track() | Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt über |
| untrack() | Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen aufrufen |
Details zur Eigenschaft
context
Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
description
Dient zum Abrufen oder Festlegen der Beschreibung des Bilds.
description: string;Eigenschaftswert
string
Hinweise
height
Dient zum Abrufen oder Festlegen der Höhe des Bildlayouts.
height: number;Eigenschaftswert
number
Hinweise
hyperlink
Dient zum Abrufen oder Festlegen des Hyperlinks des Bilds.
hyperlink: string;Eigenschaftswert
string
Hinweise
id
Ruft die ID des Image-Objekts ab.
readonly id: string;Eigenschaftswert
string
Hinweise
ocrData
Ruft die von OCR (Optical Character Recognition) dieses Bilds abgerufenen Daten ab, z. B. OCR-Text und -Sprache.
readonly ocrData: OneNote.ImageOcrData;Eigenschaftswert
Hinweise
Beispiele
let image = null;
await OneNote.run(async (context) => {
// Get the current outline.
const outline = context.application.getActiveOutline();
// Queue a command to load paragraphs and their types.
outline.load("paragraphs")
await context.sync();
for (let i=0; i < outline.paragraphs.items.length; i++) {
const paragraph = outline.paragraphs.items[i];
if (paragraph.type == "Image")
{
image = paragraph.image;
}
}
if (image != null) {
image.load("ocrData");
}
await context.sync();
// Log ocrText and ocrLanguageId.
console.log(image.ocrData.ocrText);
console.log(image.ocrData.ocrLanguageId);
});
pageContent
Ruft das PageContent-Objekt ab, das das Bild enthält. Wird ausgelöst, wenn das Bild nicht ein direkt untergeordnetes Element eines PageContent-Objekts ist. Dieses Objekt definiert die Position des Bilds auf der Seite.
readonly pageContent: OneNote.PageContent;Eigenschaftswert
Hinweise
paragraph
Ruft das Paragraph-Objekt ab, das das Bild enthält. Löst aus, wenn das Bild kein direktes untergeordnetes Element eines Absatzes ist.
readonly paragraph: OneNote.Paragraph;Eigenschaftswert
Hinweise
width
Dient zum Abrufen oder Festlegen der Breite des Bildlayouts.
width: number;Eigenschaftswert
number
Hinweise
Details zur Methode
getBase64Image()
Ruft die base64-verschlüsselte binäre Darstellung des Bilds ab. Beispiel: data:image/png; base64,iVBORw0KGgoAAAANSUhEUgAAADIA...
getBase64Image(): OfficeExtension.ClientResult<string>;Gibt zurück
OfficeExtension.ClientResult<string>
Hinweise
Beispiele
let image = null;
let imageString;
await OneNote.run(async (context) => {
// Get the current outline.
const outline = context.application.getActiveOutline();
// Queue a command to load paragraphs and their types.
outline.load("paragraphs/type")
await context.sync();
for (let i=0; i < outline.paragraphs.items.length; i++) {
const paragraph = outline.paragraphs.items[i];
if (paragraph.type == "Image")
{
image = paragraph.image;
}
}
if (image != null) {
imageString = image.getBase64Image();
await context.sync();
}
console.log(imageString);
});
load(options)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(options?: OneNote.Interfaces.ImageLoadOptions): OneNote.Image;Parameter
Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.
Gibt zurück
load(propertyNames)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNames?: string | string[]): OneNote.Image;Parameter
- propertyNames
-
string | string[]
Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.
Gibt zurück
Beispiele
await OneNote.run(async (context) => {
// Get the current outline.
const outline = context.application.getActiveOutline();
let image = null;
// Queue a command to load paragraphs and their types.
outline.load("paragraphs/type")
await context.sync();
for (let i=0; i < outline.paragraphs.items.length; i++) {
const paragraph = outline.paragraphs.items[i];
if (paragraph.type == "Image")
{
image = paragraph.image;
}
}
if (image != null) {
// Load all properties and relationships.
image.load(["id", "width", "height", "description", "hyperlink"]);
await context.sync();
}
if (image != null) {
console.log("image " + image.id + " width is " + image.width + " height is " + image.height);
console.log("description: " + image.description);
console.log("hyperlink: " + image.hyperlink);
}
});
load(propertyNamesAndPaths)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): OneNote.Image;Parameter
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.
Gibt zurück
set(properties, options)
Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.
set(properties: Interfaces.ImageUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameter
- properties
- OneNote.Interfaces.ImageUpdateData
Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.
- options
- OfficeExtension.UpdateOptions
Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt versucht, schreibgeschützte Eigenschaften festzulegen.
Gibt zurück
void
set(properties)
Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.
set(properties: OneNote.Image): void;Parameter
- properties
- OneNote.Image
Gibt zurück
void
toJSON()
Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche OneNote.Image Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als OneNote.Interfaces.ImageData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): OneNote.Interfaces.ImageData;Gibt zurück
track()
Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt über .sync Aufrufe hinweg und außerhalb der sequenziellen Ausführung eines ".run"-Batches verwenden und beim Festlegen einer Eigenschaft oder beim Aufrufen einer Methode für das Objekt den Fehler "InvalidObjectPath" erhalten, müssen Sie das Objekt der nachverfolgten Objektauflistung hinzufügen, als das Objekt zum ersten Mal erstellt wurde.
track(): OneNote.Image;Gibt zurück
untrack()
Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen aufrufen context.sync() , bevor die Speicherfreigabe wirksam wird.
untrack(): OneNote.Image;Gibt zurück
Office Add-ins