Editor Control names - Author-it On-Premises

This section contains reference documentation for control of the Editor in Author. You can change the availability of these controls in your control deactivation plugin when you set the DeactivateUIControlArgs.ParentForm property value to TargetForm.BookEditor.

Edit tab

The Edit tab contains groups with controls that you use to edit topics and their contents. Set the DeactivateUIControlArgs.ControlName property value to Edit to control the availability of the Edit tab in your control deactivation plugin.

The screenshot and table below show the names of buttons on the Author Edit tab.

			On-screen label	Control name
Tab			Edit	Edit
	Group		Save	Save
		1	Save Topic	SaveTopic
	Group		Clipboard	Clipboard
		2	Cut	Cut
		3	Copy	Copy
		4	Paste	Paste
	Group		Format	Format
		5	Apply Character Style	characterStyleButtonItem
		6	Apply Paragraph Style	paragraphStyleButtonItem
		7	Show Paragraph Markers	WriteParagraphMarkers
		8	Change Case	changeCaseButtonItem
	Group		Insert	Insert
		9	Insert Non-Breaking Hyphen	AdvancedToolsNonBreakingHyphen
		10	Insert Non-Breaking Space	AdvancedToolsNonBreakingSpace
		11	Insert File Object	WriteCreateFile
		12	Insert Hyperlink Object	WriteCreateHyperlink
		13	Insert OLE Object	WriteCreateOle
		14	Insert Picture Object	WriteCreatePicture
		15	Insert Symbol	WriteSymbol
		16	Insert File Object from Thumbnail	WriteInsertFileFromThumbnail
	Group		Tables	Tables
		17	Insert Table	Table
	Group		Xtend	Xtend
		18	Xtend Advanced Search	WriteAuthoringMemoryAdvancedReuse
		19	Xtend Highlighting	WriteAuthoringMemoryHighlighting
	Group		Variables	Variables
		20	Manage variables for the current topic	Variables
	Group		Assign	Assign
		21	Assign Template	Template
		22	Assign Release State	ReleaseState
	Group		Variants	Variants
		23	Create New Variant	NewVariant
		24	Convert To Variant	MakeVariant
		25	Remove Variant Association	DeleteVariant
		26	Filter	VariantFilter
		27	Edit Variant	EditVariant

Layout tab

The Layout tab contains groups with controls that you use to edit tables and their content. Set the DeactivateUIControlArgs.ControlName property value to Layout to control the availability of the Layout tab in your control deactivation plugin.

The screen shot and list below show the names of controls on the Author Layout tab.

			On-screen label	Control name
Tab			Layout	Layout
	Group		Table	Table
		1	Select	Select
		2	Show Gridlines	ShowGridlines
		3	Lock Layout	LockLayout
	Group		Rows & Columns	RowsColumns
		4	Delete	Delete
		5	Insert Above	InsertAbove
		6	Insert Below	InsertBelow
		7	Insert Left	InsertLeft
		8	Insert Right	InsertRight
		9	Move	Move
	Group		Design	Design
		10	None	None
		11	All	All
		12	Outer	Outer
		13	Shading	Shading
		14	Borders	Borders
	Group		Cell Size	CellSize
		15	Distribute Rows	DistributeRows
		16	Distribute Columns	DistributeColumns
	Group		Merge	Merge
		17	Merge Cells	MergeCells
		18	Split Cells	SplitCells
		19	Split Table	SplitTable
	Group		Advanced	Advanced
		20	Align Top	AlignTop
		21	Align Center	AlignCenter
		22	Align Bottom	AlignBottom
		23	Text Direction	TextDirection
		24	Repeat Heading Rows	RepeatHeadingRows
		25	Allow Row Break	AllowRowBreak

Publish tab

The Publish tab contains groups with controls that you use to publish books. Set the DeactivateUIControlArgs.ControlName property value to Publish to control the availability of the Publish tab in your control deactivation plugin.

The screen shot and list below show the names of controls on the Author Publish tab in the book editor.

			On-screen label	Control name
Tab			Publish	Publish
	Group		Publish To	PublishTo
		1	Print	PublishToPrint
		2	Web	PublishToWeb
		3	Help	PublishToHelp
		4	XML	PublishToXML

Review tab

The Review tab contains groups with controls that you use to perform content validation. Set the DeactivateUIControlArgs.ControlName property value to Review to control the availability of the Review tab in your control deactivation plugin.

The screen shot and list below show the names of controls on the Author Review tab.

The Review Tab of the Author Editor

			On-screen label	Control name
Tab			Review	Review
	Group		Spell Check	SpellCheck
		1	Check Spelling	CheckSpelling
		2	Check Spelling of Book	CheckSpellingOfBook
	Group		Find	Find
		3	Find	Find
		4	Find and Replace	FindAndReplace
	Group		Sort	Sort
		5	Sort Order	SortOrder
		6	Validate Topic	ValidateTopic
	Group		Structured Authoring	StructuredAuthoring
		7	Validate Book	ValidateBook

View tab

The View tab contains groups with controls that you use to control what you see in the user interface. Set the DeactivateUIControlArgs.ControlName property value to View to control the availability of the View tab in your control deactivation plugin.

The screen shot and list below show the names of controls on the Author View tab.

			On-screen label	Control name
Tab			View	View
	Group		Display	Display
		1	Details	Details
		2	Reset Panels	ResetPanels
	Group		Print	Print
		3	Print Book	PrintBook
		4	Print Topic	PrintTopic
	Group		Show	Show
		5	History	History
		6	Relationships	Relationships
		7	Topic Properties	TopicProperties
		8	Book Properties	BookProperties
		9	Locate	Locate

Object context menu in the Editor

Most controls on the Editor's tabs are also in its object context menu. This menu opens when users right-click an object. Set the DeactivateUIControlArgs.ControlType property value to UIControlType.BookTreeMenuItem and the DeactivateUIControlArgs.ParentForm property value to TargetForm.BookEditor to control the availability of items in the Editor's context menu in your control deactivation plugin.

On-screen label	Control name
Open	Open
Open In New Window	OpenInNewWindow
Locate	Locate
New	New
Remove	Remove
New Variant	NewVariant
Cut	Cut
Copy	Copy
Paste	Paste
Show Relationships	ShowRelationships
Show History	ShowHistory
Sort Children	SortChildren
Sort Siblings	SortSiblings
Variables	Variables
Change Release State	ChangeReleaseState
Apply Template	ApplyTemplate
Properties	Properties