VCOO0038

OmniOutliner: Clear Custom Formatting

A command for removing custom formatting (local style attributes) from either the selected item(s) or all items if no items are selected.

NOTE: This command processes all text columns in the targeted row(s), including item notes.

Scope and Syntax

Language: English (United States 🇺🇸 · Great Britain 🇬🇧 · Australia 🇦🇺 · Canada 🇨🇦)

Scope: OmniOutliner

Command phrase variations (words in [brackets] are optional):

• “Clear Custom Formatting”
• “Clear Added Formatting”

Requirements

• OmniOutliner: 5.10 (macOS), OmniOutliner 3.9.1 (iOS/iPadOS)
• System: macOS 12, iOS 15, iPadOS 15

Video: Clear Custom Formatting

A command for removing custom formatting (local style attributes) from either the selected item(s) or all items if no items are selected.

PLAY (E) PAUSE BACK REWIND

Downloads

• ⇩ COMMANDS-FILE (OmniOutliner 5) (macOS)
• ⇩ SHORTCUT-LINK (“Clear Custom Formatting”) (iOS/iPadOS)

Script Code

Here is the script code.

NOTE: The command presents an alert so that the user may decide whether or not to preserve existing links embedded in the outline items and notes.

Clear Custom Formatting
Copy

(async () => {
	try {
		function createUtterance(textToSpeak){
			AlexID = (
				(app.platformName === "macOS") ? 
				"com.apple.speech.synthesis.voice.Alex" : 
				"com.apple.speech.voice.Alex"
			)
			voiceObj = Speech.Voice.withIdentifier(AlexID)
			voiceRate = 0.4
			utterance = new Speech.Utterance(textToSpeak)
			utterance.voice = voiceObj
			utterance.rate = voiceRate
			return utterance
		}
		var synthesizer = new Speech.Synthesizer()
		
		try {document.name} catch(err){
			throw {name:"Missing Resource", message:"No outline document is open."}
		}
		
		alertTitle = "Confirmation Required"
		alertMessage = "Should existing links be preserved?"
		alert = new Alert(alertTitle, alertMessage)
		alert.addOption("Preserve Links")
		alert.addOption("Clear Links")
		alert.addOption("Cancel")
		
		voiceMessage = "Clearing local style attributes. Should existing links be preserved?"
		utterance = createUtterance(voiceMessage)
		synthesizer.speakUtterance(utterance)
		buttonIndex = await alert.show()
				
		if(buttonIndex === 2){return "user cancelled"}
		
		var items = document.editors[0].selection.items
				
		if (items.length === 0){
			var processItems = rootItem.descendants
		} else {
			var processItems = items
		}
		
		var textColumns = columns.filter(col => {
			return col.type === Column.Type.Text
		})

		processItems.forEach(item => {
			textColumns.forEach(col => {
				try {
					textObj = item.valueForColumn(col)
					newText = new Text("", textObj.style)
					textObj.attributeRuns.forEach(run => { 
						if(buttonIndex === 0){
							if(!run.style.link){run.style.clear()}
						} else {
							run.style.clear()
						}
						newText.append(run) 
					}) 
					item.setValueForColumn(newText, col)
				}
				catch(err){console.log(item.topic)}
			})
		})
		itemOrItems = (processItems.length === 1) ? "item":"items"
		linksMessage = (buttonIndex === 0) ? " with links preserved": ""
		response = `${processItems.length} ${itemOrItems} cleared${linksMessage}.`
	
		utterance = createUtterance(response)
		synthesizer.speakUtterance(utterance)
	}
	catch(err){
		utterance = createUtterance(err.message)
		synthesizer.speakUtterance(utterance)
		//new Alert(err.name, err.message).show()
	}
})();