VCOO0031

OmniOutliner: Save Clipboard Text

This command will present a custom interface for saving the clipboard text to the OmniOutliner Documents folder on either iOS/iPadOS or macOS devices.

Scope and Syntax

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

Scope: OmniOutliner

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

• “Save [OmniOutliner] Clipboard Text”

Requirements

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

Video: Save Clipboard Text

This command will save the clipboard text to the OmniOutliner Documents folder on either iOS/iPadOS or macOS devices.

PLAY (E) PAUSE BACK REWIND

Downloads

• ⇩ COMMANDS-FILE (OmniOutliner 5) (macOS)
• ⇩ SHORTCUT-LINK (“Save [OmniOutliner] Clipboard Text”) (iOS/iPadOS)

Script Code

The clipboard text can be saved as "Text (plain)", "TaskPaper", "HTML", "JavaScript", or "SVG". NOTE: The corresponding file extension will automatically be appended to the provided file name.

On macOS, there is an optional checkbox for indicating the saved file should be automatically opened after saving.

Here is the script code:

Save Clipboard Text
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()
		
		if(!Pasteboard.general.hasStrings){
			throw {
				name: "No Text",
				message: "There is no text on the clipboard to save."
			}
		}

		inputForm = new Form()
		
		fileNameField = new Form.Field.String(
			"fileBaseName",
			"File Name",
			null,
			null
		)
		inputForm.addField(fileNameField)
	
		fileTypes = ["Text (plain)", "TaskPaper", "HTML", "JavaScript", "SVG"]
		nameExtensions = ["txt", "taskpaper", "html", "js", "svg"]
		savingTypeMenu = new Form.Field.Option(
			"nameExtension", 
			"Text File Type", 
			nameExtensions, 
			fileTypes, 
			nameExtensions[0]
		)
		inputForm.addField(savingTypeMenu)
		
		if (Device.current.mac){
			shouldOpenFileField = new Form.Field.Checkbox(
				"shouldOpenFile",
				"Open file in default application",
				null
			)
			inputForm.addField(shouldOpenFileField)
		}
		
		inputForm.validate = function(formObject){
			textValue = formObject.values['fileBaseName']
			return (textValue && textValue.length > 0) ? true:false
		}
	
		formPrompt = `Clipboard to ${app.name} Documents`
		buttonTitle = "Continue"
		
		utterance = createUtterance("Please indicate the file name and file type:")
		synthesizer.speakUtterance(utterance)
		
		formObject = await inputForm.show(formPrompt, buttonTitle)
		
		fileBaseName = formObject.values["fileBaseName"]
		nameExtension = formObject.values["nameExtension"]
		fileName = fileBaseName + "." + nameExtension
		if (Device.current.mac){
			var shouldOpenFile = formObject.values["shouldOpenFile"]
		}
	
		folderURL = URL.documentsDirectory
		fileURL = folderURL.appendingPathComponent(fileName)
		textData = Data.fromString(Pasteboard.general.string, StringEncoding.UTF8)

		wrapper = FileWrapper.withContents(fileName, textData)
		wrapper.write(fileURL, [FileWrapper.WritingOptions.Atomic], null)
		
		if (Device.current.mac){
			if(shouldOpenFile){fileURL.open()}
		}

		utterance = createUtterance("Done!")
		synthesizer.speakUtterance(utterance)
	}
	catch(err){
		if(!err.causedByUserCancelling){
			utterance = createUtterance(err.message)
			synthesizer.speakUtterance(utterance)
			//new Alert(err.name, err.message).show()
		}
	}
})();