Tutorial

Getting Started with Macros

Macro Editor

User Interface

Editing Macro Statements

Expression Editor

How To

Using variables

Finding and modifying objects

Creating new page content

Asking for user input

Sorting objects

Macro Logging

Sample Macros

Concepts

Expressions

Objects

Properties

Variables

Data Types

Arrays

Functions

Literals

Operators

Comments

Image Object

Description

Represents an image in a OneNote page.

Hierarchical Structure

Image objects can be found under following objects: Paragraph Page

Creating Image Objects

Image objects cannot be inserted with Onetastic Macros

Properties

Name Type Access Description
altText String read-write Alternative text for this Image. Used if the page is exported as HTML.
background Bool read-write Whether this Image is a background image or not. Background images aren't selectable and show up behind every other object.
format ImageFormat read-write Encoding format of this Image. See data types for possible values.
height Numeric read-write The height of this Image in points.
hyperlink String read-write Hyperlink of this Image user would navigate to this hyperlink when Ctrl+clicking on this Image).
isPrintOut Bool read-write Whether this Image is a printout or not.
lastModifiedTime DateTime read-write The date and time of last modification on this Image.
objectId String read-write The unique identifier of this Image.
printOutDocumentNumber Numeric read-write The document number that points to corresponding the printout file on the page for this Image. Only valid for printouts.
printOutFileNumber Numeric read-write The file number that points to corresponding the printout file on the page for this Image. Only valid for printouts.
printOutPageNumber Numeric read-write The page number that points to corresponding the printout file on the page for this Image. Only valid for printouts.
selection Selection read-write Whether this Image is fully or partially selected or not.
sizeSetByUser Bool read-write Whether the dimensions of this Image is manually set by the user (by dragging a handle on the object). Objects whose dimensions are set by the user will retain that size regardless of the size of their containers.
tags Array<Tag> read-only List of tags associated with this Image.
type ObjectType read-only Type of this object. Always has the value of "Image".
width Numeric read-write The width of this Image in points.
x Numeric read-write The horizontal position of this Image on the page in points.
y Numeric read-write The vertical position of this Image on the page in points.
z Numeric read-write The z-order of this Image on the page. Objects with higher z-order will show up in front of objects with lower z-orders.

Deprecated Properties

Following properties are deprecated. Do not use these in new macros. See descriptions below on what to use instead.

Name Type Access Description
tagCompleted Bool read-write Whether the first tag associated with this Image is completed (checked) or not. This property is deprecated. Use tags property instead.
tagCompletionDate DateTime read-write The date and time of completion of the first tag associated with this Image. This property is deprecated. Use tags property instead.
tagCreationDate DateTime read-write The date and time of creation of the first tag associated with this Image. This property is deprecated. Use tags property instead.
tagDisabled Bool read-write Whether the first tag associated with this Image is disabled (dimmed) or not. This property is deprecated. Use tags property instead.
tagFontColor Color read-only The font color for the first tag associated with this Image for tags that use formatting instead of a symbol. This property is deprecated. Use tags property instead.
tagHighlightColor Color read-only The highlight color for the first tag associated with this Image for tags that use formatting instead of a symbol. This property is deprecated. Use tags property instead.
tagName String read-only The name of the first tag associated with this Image. This property is deprecated. Use tags property instead.
tagSymbol Numeric read-only The symbol used for the first tag associated with this Image. This property is deprecated. Use tags property instead.
tagType Numeric read-only The type of the first tag associated with this Image. This property is deprecated. Use tags property instead.

Reference

Statements

ForEach

If

Else

While

Expression

Comment

Break

Continue

Hierarchy Objects

NotebookRoot

Notebook

SectionGroup

Section

Page

Page Objects

Title

Outline

Table

Column

Row

Cell

Paragraph

Text

Image

EmbeddedFile

Tag

Other Objects

DialogBox

Functions

Array Functions

Date/Time Functions

Dialog Box Functions

Macro Execution Functions

Object Functions

String Functions