Skip to content

word permstart

goworm edited this page Jun 26, 2026 · 1 revision

Word: Permission Start Marker

Ranged editing-permission marker that opens a region a group or specific user may edit inside a protected document.

Path: /body/p[N]/permStart[M]

Operations

  • add - Open a permission region
  • get - Read marker attributes
  • remove - Delete a permission marker

add

Parent: body|paragraph

Properties

Property Required/Default Description
id required Marker id. permStart and its matching permEnd share the same id.
edGrp Editing group allowed in the region (ST_EdGrp). One of: none, everyone, administrators, contributors, editors, owners, current.
ed Specific user (e.g. domain\user or email) allowed to edit the region.
colFirst First table column (0-based) the permission applies to, for a table-column range.
colLast Last table column (0-based) the permission applies to, for a table-column range.

get Attributes

Attribute Type Description
id number Marker id (w:id)
edGrp enum Editing group allowed in the region (w:edGrp)
ed string Specific user allowed to edit the region (w:ed)
colFirst number First table column in the permission range (w:colFirst)
colLast number Last table column in the permission range (w:colLast)

Examples

# Open a permission region for everyone, id 5
officecli add report.docx /body/p[0] --type permStart \
  --prop id=5 --prop edGrp=everyone

# Open a region for a specific user
officecli add report.docx /body/p[2] --type permStart \
  --prop id=7 --prop ed=jane@example.com

# Scope the permission to a table-column range (columns 0 through 2)
officecli add report.docx /body/p[1] --type permStart \
  --prop id=9 --prop edGrp=editors \
  --prop colFirst=0 --prop colLast=2

# Read marker attributes
officecli get report.docx "/body/p[0]/permStart[0]"

# Remove a permission marker
officecli remove report.docx "/body/p[0]/permStart[0]"

Notes

  • <w:permStart>/<w:permEnd> delimit a region that a group (edGrp) or specific user (ed) may edit inside a protected document.
  • permStart and permEnd are positioned as paragraph children, like bookmark markers: permStart opens the region and permEnd closes the matching id. Pair them by sharing the same id (permEnd carries id only).
  • colFirst/colLast scope the permission to a table-column range.

See Also


Based on OfficeCLI v1.0.119

Clone this wiki locally