Class WordSceneEditor

Namespace

ComOfficeKit.Model

Assembly

ComOfficeKit.dll

The Apple SDK's WordSceneEditor, on one document: each method is the Swift function of its name, run by the engine on the document as one undo step. A position or an id comes from a model read, such as GetScene(), and a snapshot read before an edit keeps its old values: read again after one.

public sealed class WordSceneEditor

Inheritance

object

WordSceneEditor

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

AddTabStop(Guid, WordScenePosition, long)

The Apple SDK's WordSceneEditor.addTabStop(paragraphID:caret:in:stepTwips:), on this document. One undo step.

public long AddTabStop(Guid paragraphID, WordScenePosition caret, long stepTwips = 720)

Parameters

paragraphID Guid

Swift's paragraphID (UUID).

caret WordScenePosition

Swift's caret (WordScenePosition).

stepTwips long

Swift's stepTwips (Int): from 1 to 31680.

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.

AdjustFirstLineIndent(long, Guid, WordScenePosition)

The Apple SDK's WordSceneEditor.adjustFirstLineIndent(byTwips:paragraphID:caret:in:), on this document. One undo step.

public long AdjustFirstLineIndent(long byTwips, Guid paragraphID, WordScenePosition caret)

Parameters

byTwips long

Swift's byTwips (Int): from -31680 to 31680.

paragraphID Guid

Swift's paragraphID (UUID).

caret WordScenePosition

Swift's caret (WordScenePosition).

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.

AdjustLeftIndent(long, Guid, WordScenePosition)

The Apple SDK's WordSceneEditor.adjustLeftIndent(byTwips:paragraphID:caret:in:), on this document. One undo step.

public long AdjustLeftIndent(long byTwips, Guid paragraphID, WordScenePosition caret)

Parameters

byTwips long

Swift's byTwips (Int): from -31680 to 31680.

paragraphID Guid

Swift's paragraphID (UUID).

caret WordScenePosition

Swift's caret (WordScenePosition).

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.

AdjustRightIndent(long, Guid, WordScenePosition)

The Apple SDK's WordSceneEditor.adjustRightIndent(byTwips:paragraphID:caret:in:), on this document. One undo step.

public long AdjustRightIndent(long byTwips, Guid paragraphID, WordScenePosition caret)

Parameters

byTwips long

Swift's byTwips (Int): from -31680 to 31680.

paragraphID Guid

Swift's paragraphID (UUID).

caret WordScenePosition

Swift's caret (WordScenePosition).

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.

ApplyFormatting(WordScenePosition, WordScenePosition, WordRunFormattingChange)

The Apple SDK's WordSceneEditor.applyFormatting(from:to:in:_:), on this document. One undo step.

public long ApplyFormatting(WordScenePosition from, WordScenePosition to, WordRunFormattingChange formatting)

Parameters

from WordScenePosition

Swift's from (WordScenePosition).

to WordScenePosition

Swift's to (WordScenePosition).

formatting WordRunFormattingChange

What to change in each run's WordRunFormatting: the members set, or cleared.

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.

CanInsertNote(WordScenePosition)

The Apple SDK's WordSceneEditor.canInsertNote(at:in:), on this document as it stands. It changes nothing.

public bool CanInsertNote(WordScenePosition at)

Parameters

at WordScenePosition

Swift's at (WordScenePosition).

Returns

bool

What the function returns (Bool).

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument.

DeleteBackward(WordScenePosition)

The Apple SDK's WordSceneEditor.deleteBackward(at:in:), on this document. One undo step.

public long DeleteBackward(WordScenePosition at)

Parameters

at WordScenePosition

Swift's at (WordScenePosition).

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.

DeleteForward(WordScenePosition)

The Apple SDK's WordSceneEditor.deleteForward(at:in:), on this document. One undo step.

public long DeleteForward(WordScenePosition at)

Parameters

at WordScenePosition

Swift's at (WordScenePosition).

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.

DeleteInlineImageRun(Guid, Guid)

The Apple SDK's WordSceneEditor.deleteInlineImageRun(paragraphID:runID:in:), on this document. One undo step.

public long DeleteInlineImageRun(Guid paragraphID, Guid runID)

Parameters

paragraphID Guid

Swift's paragraphID (UUID).

runID Guid

Swift's runID (UUID).

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.

DeleteRange(WordScenePosition, WordScenePosition)

The Apple SDK's WordSceneEditor.deleteRange(from:to:in:), on this document. One undo step.

public long DeleteRange(WordScenePosition from, WordScenePosition to)

Parameters

from WordScenePosition

Swift's from (WordScenePosition).

to WordScenePosition

Swift's to (WordScenePosition).

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.

DeleteTableColumn(Guid)

The Apple SDK's WordSceneEditor.deleteTableColumn(atParagraph:in:), on this document. One undo step.

public long DeleteTableColumn(Guid atParagraph)

Parameters

atParagraph Guid

Swift's atParagraph (UUID).

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.

DeleteTableRow(Guid)

The Apple SDK's WordSceneEditor.deleteTableRow(atParagraph:in:), on this document. One undo step.

public long DeleteTableRow(Guid atParagraph)

Parameters

atParagraph Guid

Swift's atParagraph (UUID).

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.

EditHeaderFooter(WordHeaderFooterRole, WordScenePosition?)

The Apple SDK's WordSceneEditor.editHeaderFooter(_:at:in:), on this document. One undo step.

public long EditHeaderFooter(WordHeaderFooterRole role, WordScenePosition? at)

Parameters

role WordHeaderFooterRole

Swift's role (WordHeaderFooter.Role).

at WordScenePosition

Swift's at (WordScenePosition?).

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.

FindMatches(string, bool)

The Apple SDK's WordSceneEditor.findMatches(of:in:caseSensitive:), on this document as it stands. It changes nothing.

public IReadOnlyList<WordSceneEditorWordTextMatch> FindMatches(string of, bool caseSensitive = false)

Parameters

of string

Swift's of (String).

caseSensitive bool

Swift's caseSensitive (Bool).

Returns

IReadOnlyList<WordSceneEditorWordTextMatch>

What the function returns ([WordSceneEditor.WordTextMatch]).

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument.

HasTableOfContents()

The Apple SDK's WordSceneEditor.hasTableOfContents(_:), on this document as it stands. It changes nothing.

public bool HasTableOfContents()

Returns

bool

What the function returns (Bool).

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument.

Insert(string, WordScenePosition)

The Apple SDK's WordSceneEditor.insert(_:at:in:), on this document. One undo step.

public long Insert(string text, WordScenePosition at)

Parameters

text string

Swift's text (String).

at WordScenePosition

Swift's at (WordScenePosition).

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.

InsertCaption(string, WordScenePosition)

The Apple SDK's WordSceneEditor.insertCaption(_:at:in:), on this document. One undo step.

public long InsertCaption(string label, WordScenePosition at)

Parameters

label string

Swift's label (String).

at WordScenePosition

Swift's at (WordScenePosition).

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.

InsertEndnote(WordScenePosition)

The Apple SDK's WordSceneEditor.insertEndnote(at:in:), on this document. One undo step.

public long InsertEndnote(WordScenePosition at)

Parameters

at WordScenePosition

Swift's at (WordScenePosition).

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.

InsertFootnote(WordScenePosition)

The Apple SDK's WordSceneEditor.insertFootnote(at:in:), on this document. One undo step.

public long InsertFootnote(WordScenePosition at)

Parameters

at WordScenePosition

Swift's at (WordScenePosition).

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.

InsertHyperlink(string, string, WordScenePosition)

The Apple SDK's WordSceneEditor.insertHyperlink(url:title:at:in:), on this document. One undo step.

public long InsertHyperlink(string url, string title, WordScenePosition at)

Parameters

url string

Swift's url (String).

title string

Swift's title (String).

at WordScenePosition

Swift's at (WordScenePosition).

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.

InsertInlineImage(byte[], double, double, WordScenePosition, string?)

The Apple SDK's WordSceneEditor.insertInlineImage(_:at:in:) on this document, with the picture given as its bytes: inline at a place in the body, a table, a header, a footer or a note, the caret after it. One undo step.

public long InsertInlineImage(byte[] data, double widthPt, double heightPt, WordScenePosition at, string? altText = null)

Parameters

data byte[]

The picture's bytes: PNG, JPEG, GIF, BMP or TIFF, at most 64 MB. The engine keeps a copy, which a save writes into the document; GetImageData(Guid, Guid) reads it back.

widthPt double

Its width in points: above 0 and at most 1,584, Word's 22 inches.

heightPt double

Its height in points: above 0 and at most 1,584.

at WordScenePosition

Where it goes: a place in the body, a table, a header, a footer or a note, whose part the save writes it into. A text box takes none.

altText string

Its alternative text, or null for none.

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses the picture, its size or the place.

InsertPageNumber(WordScenePosition?)

The Apple SDK's WordSceneEditor.insertPageNumber(at:in:), on this document. One undo step.

public long InsertPageNumber(WordScenePosition? at)

Parameters

at WordScenePosition

Swift's at (WordScenePosition?).

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.

InsertSectionBreak(Guid?)

The Apple SDK's WordSceneEditor.insertSectionBreak(afterParagraph:in:), on this document. One undo step.

public long InsertSectionBreak(Guid? afterParagraph)

Parameters

afterParagraph Guid?

Swift's afterParagraph (UUID?).

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.

InsertTable(long, long, Guid?)

The Apple SDK's WordSceneEditor.insertTable(rows:columns:afterParagraph:in:), on this document. One undo step.

public long InsertTable(long rows, long columns, Guid? afterParagraph)

Parameters

rows long

Swift's rows (Int): from 1 to 1000.

columns long

Swift's columns (Int): from 1 to 63.

afterParagraph Guid?

Swift's afterParagraph (UUID?).

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.

InsertTableColumn(Guid, bool)

The Apple SDK's WordSceneEditor.insertTableColumn(atParagraph:after:in:), on this document. One undo step.

public long InsertTableColumn(Guid atParagraph, bool after)

Parameters

atParagraph Guid

Swift's atParagraph (UUID).

after bool

Swift's after (Bool).

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.

InsertTableOfContents(WordScenePosition, long)

The Apple SDK's WordSceneEditor.insertTableOfContents(at:tabTwips:in:layout:), on this document. One undo step.

public long InsertTableOfContents(WordScenePosition at, long tabTwips)

Parameters

at WordScenePosition

Swift's at (WordScenePosition).

tabTwips long

Swift's tabTwips (Int): from 0 to 31680.

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.

InsertTableRow(Guid, bool)

The Apple SDK's WordSceneEditor.insertTableRow(atParagraph:below:in:), on this document. One undo step.

public long InsertTableRow(Guid atParagraph, bool below)

Parameters

atParagraph Guid

Swift's atParagraph (UUID).

below bool

Swift's below (Bool).

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.

InsertTextBox(Guid?, double, double)

The Apple SDK's WordSceneEditor.insertTextBox(afterParagraph:hOffsetPt:vOffsetPt:in:), on this document. One undo step.

public long InsertTextBox(Guid? afterParagraph, double hOffsetPt = 72, double vOffsetPt = 72)

Parameters

afterParagraph Guid?

Swift's afterParagraph (UUID?).

hOffsetPt double

Swift's hOffsetPt (Double): from -4022 to 4022.

vOffsetPt double

Swift's vOffsetPt (Double): from -4022 to 4022.

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.

IsCaptionLabel(string)

The Apple SDK's WordSceneEditor.isCaptionLabel(_:), on this document as it stands. It changes nothing.

public bool IsCaptionLabel(string label)

Parameters

label string

Swift's label (String).

Returns

bool

What the function returns (Bool).

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument.

NextRevisionID()

The Apple SDK's WordSceneEditor.nextRevisionID(in:), on this document as it stands. It changes nothing.

public long NextRevisionID()

Returns

long

What the function returns (Int).

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument.

RemoveFloatingImage(Guid, long, WordScenePosition)

The Apple SDK's WordSceneEditor.removeFloatingImage(hostID:imageIndex:caret:in:), on this document. One undo step.

public long RemoveFloatingImage(Guid hostID, long imageIndex, WordScenePosition caret)

Parameters

hostID Guid

Swift's hostID (UUID).

imageIndex long

Swift's imageIndex (Int): from 0 to 10000.

caret WordScenePosition

Swift's caret (WordScenePosition).

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.

RemoveLastTabStop(Guid, WordScenePosition)

The Apple SDK's WordSceneEditor.removeLastTabStop(paragraphID:caret:in:), on this document. One undo step.

public long RemoveLastTabStop(Guid paragraphID, WordScenePosition caret)

Parameters

paragraphID Guid

Swift's paragraphID (UUID).

caret WordScenePosition

Swift's caret (WordScenePosition).

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.

ReplacingRunText(Guid, Guid, ModelRange, string)

The Apple SDK's WordSceneEditor.replacingRunText(paragraphID:runID:range:with:in:), on this document. One undo step.

public long ReplacingRunText(Guid paragraphID, Guid runID, ModelRange range, string with)

Parameters

paragraphID Guid

Swift's paragraphID (UUID).

runID Guid

Swift's runID (UUID).

range ModelRange

Swift's range (Range<Int>).

with string

Swift's with (String).

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.

ResolvingRevisions(WordDocumentSceneRevisionResolution, WordScenePosition?, WordScenePosition?)

The Apple SDK's WordSceneEditor.resolvingRevisions(_:at:selectionAnchor:in:), on this document. One undo step.

public long ResolvingRevisions(WordDocumentSceneRevisionResolution how, WordScenePosition? at, WordScenePosition? selectionAnchor)

Parameters

how WordDocumentSceneRevisionResolution

Swift's how (WordDocumentScene.RevisionResolution).

at WordScenePosition

Swift's at (WordScenePosition?).

selectionAnchor WordScenePosition

Swift's selectionAnchor (WordScenePosition?).

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.

RunFormatting(WordScenePosition)

The Apple SDK's WordSceneEditor.runFormatting(at:in:), on this document as it stands. It changes nothing.

public WordRunFormatting? RunFormatting(WordScenePosition at)

Parameters

at WordScenePosition

Swift's at (WordScenePosition).

Returns

WordRunFormatting

What the function returns (WordRunFormatting?).

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument.

SelectedText(WordScenePosition, WordScenePosition)

The Apple SDK's WordSceneEditor.selectedText(from:to:in:), on this document as it stands. It changes nothing.

public string SelectedText(WordScenePosition from, WordScenePosition to)

Parameters

from WordScenePosition

Swift's from (WordScenePosition).

to WordScenePosition

Swift's to (WordScenePosition).

Returns

string

What the function returns (String).

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument.

SetAlignment(WordParagraphStyleAlignment, Guid, WordScenePosition)

The Apple SDK's WordSceneEditor.setAlignment(_:paragraphID:caret:in:), on this document. One undo step.

public long SetAlignment(WordParagraphStyleAlignment alignment, Guid paragraphID, WordScenePosition caret)

Parameters

alignment WordParagraphStyleAlignment

Swift's alignment (WordParagraphStyle.Alignment).

paragraphID Guid

Swift's paragraphID (UUID).

caret WordScenePosition

Swift's caret (WordScenePosition).

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.

SetFloatingImageGeometry(Guid, long, double, double, double, double, WordScenePosition)

The Apple SDK's WordSceneEditor.setFloatingImageGeometry(hostID:imageIndex:hOffsetPt:vOffsetPt:widthPt:heightPt:caret:in:), on this document. One undo step.

public long SetFloatingImageGeometry(Guid hostID, long imageIndex, double hOffsetPt, double vOffsetPt, double widthPt, double heightPt, WordScenePosition caret)

Parameters

hostID Guid

Swift's hostID (UUID).

imageIndex long

Swift's imageIndex (Int): from 0 to 10000.

hOffsetPt double

Swift's hOffsetPt (Double): from -4022 to 4022.

vOffsetPt double

Swift's vOffsetPt (Double): from -4022 to 4022.

widthPt double

Swift's widthPt (Double): from 0.1 to 1584.

heightPt double

Swift's heightPt (Double): from 0.1 to 1584.

caret WordScenePosition

Swift's caret (WordScenePosition).

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.

SetInlineImageSize(Guid, Guid, double, double, WordScenePosition)

The Apple SDK's WordSceneEditor.setInlineImageSize(paragraphID:runID:widthPt:heightPt:caret:in:), on this document. One undo step.

public long SetInlineImageSize(Guid paragraphID, Guid runID, double widthPt, double heightPt, WordScenePosition caret)

Parameters

paragraphID Guid

Swift's paragraphID (UUID).

runID Guid

Swift's runID (UUID).

widthPt double

Swift's widthPt (Double): from 0.1 to 1584.

heightPt double

Swift's heightPt (Double): from 0.1 to 1584.

caret WordScenePosition

Swift's caret (WordScenePosition).

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.

SetLineSpacing(double, Guid, WordScenePosition)

The Apple SDK's WordSceneEditor.setLineSpacing(multiple:paragraphID:caret:in:), on this document. One undo step.

public long SetLineSpacing(double multiple, Guid paragraphID, WordScenePosition caret)

Parameters

multiple double

Swift's multiple (Double): from 0.06 to 132.

paragraphID Guid

Swift's paragraphID (UUID).

caret WordScenePosition

Swift's caret (WordScenePosition).

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.

SetPageMargins(long, long, long, long, ModelClosedRange)

The Apple SDK's WordSceneEditor.setPageMargins(topTwips:rightTwips:bottomTwips:leftTwips:sections:in:), on this document. One undo step.

public long SetPageMargins(long topTwips, long rightTwips, long bottomTwips, long leftTwips, ModelClosedRange sections)

Parameters

topTwips long

Swift's topTwips (Int): from 0 to 31680.

rightTwips long

Swift's rightTwips (Int): from 0 to 31680.

bottomTwips long

Swift's bottomTwips (Int): from 0 to 31680.

leftTwips long

Swift's leftTwips (Int): from 0 to 31680.

sections ModelClosedRange

Swift's sections (ClosedRange<Int>).

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.

SetPageSize(WordSectionPageSize, ModelClosedRange)

The Apple SDK's WordSceneEditor.setPageSize(_:sections:in:), on this document. One undo step.

public long SetPageSize(WordSectionPageSize size, ModelClosedRange sections)

Parameters

size WordSectionPageSize

Swift's size (WordSection.PageSize): widthTwips from 144 to 31680; heightTwips from 144 to 31680.

sections ModelClosedRange

Swift's sections (ClosedRange<Int>).

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.

SetParagraphBorder(string?, Guid, WordScenePosition)

The Apple SDK's WordSceneEditor.setParagraphBorder(_:paragraphID:caret:in:), on this document. One undo step.

public long SetParagraphBorder(string? colorHex, Guid paragraphID, WordScenePosition caret)

Parameters

colorHex string

Swift's colorHex (String?).

paragraphID Guid

Swift's paragraphID (UUID).

caret WordScenePosition

Swift's caret (WordScenePosition).

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.

SetParagraphShading(string?, Guid, WordScenePosition)

The Apple SDK's WordSceneEditor.setParagraphShading(_:paragraphID:caret:in:), on this document. One undo step.

public long SetParagraphShading(string? hex, Guid paragraphID, WordScenePosition caret)

Parameters

hex string

Swift's hex (String?).

paragraphID Guid

Swift's paragraphID (UUID).

caret WordScenePosition

Swift's caret (WordScenePosition).

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.

SetParagraphStyle(string, Guid, WordScenePosition)

The Apple SDK's WordSceneEditor.setParagraphStyle(_:paragraphID:caret:in:), on this document. One undo step.

public long SetParagraphStyle(string styleID, Guid paragraphID, WordScenePosition caret)

Parameters

styleID string

Swift's styleID (String).

paragraphID Guid

Swift's paragraphID (UUID).

caret WordScenePosition

Swift's caret (WordScenePosition).

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.

SetSpacingAfter(long, Guid, WordScenePosition)

The Apple SDK's WordSceneEditor.setSpacingAfter(twips:paragraphID:caret:in:), on this document. One undo step.

public long SetSpacingAfter(long twips, Guid paragraphID, WordScenePosition caret)

Parameters

twips long

Swift's twips (Int): from 0 to 31680.

paragraphID Guid

Swift's paragraphID (UUID).

caret WordScenePosition

Swift's caret (WordScenePosition).

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.

SetSpacingBefore(long, Guid, WordScenePosition)

The Apple SDK's WordSceneEditor.setSpacingBefore(twips:paragraphID:caret:in:), on this document. One undo step.

public long SetSpacingBefore(long twips, Guid paragraphID, WordScenePosition caret)

Parameters

twips long

Swift's twips (Int): from 0 to 31680.

paragraphID Guid

Swift's paragraphID (UUID).

caret WordScenePosition

Swift's caret (WordScenePosition).

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.

SplitParagraph(WordScenePosition)

The Apple SDK's WordSceneEditor.splitParagraph(at:in:), on this document. One undo step.

public long SplitParagraph(WordScenePosition at)

Parameters

at WordScenePosition

Swift's at (WordScenePosition).

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.

TableSpanned(Guid, Guid)

The Apple SDK's WordSceneEditor.tableSpanned(from:to:in:), on this document as it stands. It changes nothing.

public WordTable? TableSpanned(Guid from, Guid to)

Parameters

from Guid

Swift's from (UUID).

to Guid

Swift's to (UUID).

Returns

WordTable

What the function returns (WordTable?).

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument.

TextColumnWidthTwips(WordScenePosition?)

The Apple SDK's WordSceneEditor.textColumnWidthTwips(at:in:), on this document as it stands. It changes nothing.

public long TextColumnWidthTwips(WordScenePosition? at)

Parameters

at WordScenePosition

Swift's at (WordScenePosition?).

Returns

long

What the function returns (Int).

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument.

ToggleList(bool, Guid, WordScenePosition)

The Apple SDK's WordSceneEditor.toggleList(bullet:paragraphID:caret:in:), on this document. One undo step.

public long ToggleList(bool bullet, Guid paragraphID, WordScenePosition caret)

Parameters

bullet bool

Swift's bullet (Bool).

paragraphID Guid

Swift's paragraphID (UUID).

caret WordScenePosition

Swift's caret (WordScenePosition).

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.

UpdateTableOfContents(WordScenePosition, long)

The Apple SDK's WordSceneEditor.updateTableOfContents(caret:tabTwips:in:layout:), on this document. One undo step.

public long UpdateTableOfContents(WordScenePosition caret, long tabTwips)

Parameters

caret WordScenePosition

Swift's caret (WordScenePosition).

tabTwips long

Swift's tabTwips (Int): from 0 to 31680.

Returns

long

The document's ModelRevision after the edit.

Exceptions

ComOfficeKitException

InvalidArgument when the engine refuses an argument, or the function makes no edit with them.