VCOO0004

OmniOutliner: Selecting Top-Level Items

This pair of commands can be used to select the top-level items of the currently selected item (row).

“Select…” will highlight the top-level items of the currently selected item (row), or all top-level outline items if no item is currently selected.

“Include…” will expand the selection to include the top-level items of the currently selected item (row), or all all top-level outline items if no item is currently selected.

NOTE: The currently selected item will be expanded to reveal its top-level items.

Scope and Syntax

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

Scope: OmniOutliner

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

“Select Top Item”
“Include Top Item”
“Select Top Items”
“Include Top Items”
“Add Top Items” (optional)

Requirements

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

Downloads

⇩ COMMANDS-FILE (OmniOutliner 5) (macOS)
⇩ SHORTCUT-LINK (“Select Top Item”) (iOS/iPadOS)
⇩ SHORTCUT-LINK (“Include Top Item”) (iOS/iPadOS)
⇩ SHORTCUT-LINK (“Select Top Items”) (iOS/iPadOS)
⇩ SHORTCUT-LINK (“Include Top Items”) (iOS/iPadOS)

Script Code

Here is the script code:

Select Top Item


(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."}
		}

		editor = document.editors[0]
		selectedNodes = editor.selectedNodes
		if(selectedNodes.length === 0){
			var selectedNode = editor.rootNode
		} else if(selectedNodes.length === 1){
			var selectedNode = selectedNodes[0]
		} else {
			throw {
				name: "Selection Issue",
				message: "This command requires, that either nothing is selected, or a single row is selected."
			}
		}
		if(selectedNode.childCount === 0){
			throw {
				name: "Missing Row",
				message: "The selected row has no child rows."
			}
		} else {
			selectedNode.expand(false)
			firstNode = selectedNode.childAtIndex(0)
			editor.select([firstNode], false)
			
			utterance = createUtterance("Ready!")
			synthesizer.speakUtterance(utterance)
		}
	}
	catch(err){
		if(!err.causedByUserCancelling){
			utterance = createUtterance(err.message)
			synthesizer.speakUtterance(utterance)
			//new Alert(err.name, err.message).show()
		}	
	}
})();

Include Top Item


(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."}
		}

		editor = document.editors[0]
		selectedNodes = editor.selectedNodes
		if(selectedNodes.length === 0){
			var selectedNode = editor.rootNode
		} else if(selectedNodes.length === 1){
			var selectedNode = selectedNodes[0]
		} else {
			throw {
				name: "Selection Issue",
				message: "This command requires, that either nothing is selected, or a single row is selected."
			}
		}
		if(selectedNode.childCount === 0){
			throw {
				name: "Missing Row",
				message: "The selected row has no child rows."
			}
		} else {
			selectedNode.expand(false)
			firstNode = selectedNode.childAtIndex(0)
			editor.select([firstNode], true)
			
			utterance = createUtterance("Ready!")
			synthesizer.speakUtterance(utterance)
		}
	}
	catch(err){
		if(!err.causedByUserCancelling){
			utterance = createUtterance(err.message)
			synthesizer.speakUtterance(utterance)
			//new Alert(err.name, err.message).show()
		}	
	}
})();

Select Top Items


(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."}
		}

		editor = document.editors[0]
		selectedNodes = editor.selectedNodes
		if(selectedNodes.length === 0){
			var selectedNode = editor.rootNode
			var selectedItem = rootItem
		} else if(selectedNodes.length === 1){
			var selectedNode = selectedNodes[0]
			var selectedItem = selectedNode.object
		} else {
			throw {
				name: "Selection Issue",
				message: "This command requires, that either nothing is selected, or a single row is selected."
			}
		}
		if(selectedNode.childCount === 0){
			throw {
				name: "Missing Row",
				message: "The selected row has no child rows."
			}
		} else {
			selectedNode.expand(false)
			console.log("selectedItem",selectedItem)
			console.log("descendants",selectedItem.descendants)

			items = document.outline.topItems(selectedItem.descendants)
			editor.select(editor.nodesForObjects(items), false)
			
			utterance = createUtterance("Ready!")
			synthesizer.speakUtterance(utterance)
		}
	}
	catch(err){
		if(!err.causedByUserCancelling){
			utterance = createUtterance(err.message)
			synthesizer.speakUtterance(utterance)
			//new Alert(err.name, err.message).show()
		}	
	}
})();

Include Top Items


(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."}
		}

		editor = document.editors[0]
		selectedNodes = editor.selectedNodes
		if(selectedNodes.length === 0){
			var selectedNode = editor.rootNode
			var selectedItem = rootItem
		} else if(selectedNodes.length === 1){
			var selectedNode = selectedNodes[0]
			var selectedItem = selectedNode.object
		} else {
			throw {
				name: "Selection Issue",
				message: "This command requires, that either nothing is selected, or a single row is selected."
			}
		}
		if(selectedNode.childCount === 0){
			throw {
				name: "Missing Row",
				message: "The selected row has no child rows."
			}
		} else {
			selectedNode.expand(false)
			console.log("selectedItem",selectedItem)
			console.log("descendants",selectedItem.descendants)

			items = document.outline.topItems(selectedItem.descendants)
			editor.select(editor.nodesForObjects(items), true)
			
			utterance = createUtterance("Ready!")
			synthesizer.speakUtterance(utterance)
		}
	}
	catch(err){
		if(!err.causedByUserCancelling){
			utterance = createUtterance(err.message)
			synthesizer.speakUtterance(utterance)
			//new Alert(err.name, err.message).show()
		}	
	}
})();

LEGAL

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Mention of third-party websites and products is for informational purposes only and constitutes neither an endorsement nor a recommendation. OMNI-AUTOMATION.COM assumes no responsibility with regard to the selection, performance or use of information or products found at third-party websites. OMNI-AUTOMATION.COM provides this only as a convenience to our users. OMNI-AUTOMATION.COM has not tested the information found on these sites and makes no representations regarding its accuracy or reliability. There are risks inherent in the use of any information or products found on the Internet, and OMNI-AUTOMATION.COM assumes no responsibility in this regard. Please understand that a third-party site is independent from OMNI-AUTOMATION.COM and that OMNI-AUTOMATION.COM has no control over the content on that website. Please contact the vendor for additional information.