Altium Designer Documentation

AddToDoItem

Created: May 2, 2019 | Updated: May 3, 2019

Parent page: TextEdit Commands

The following pre-packaged resource, derived from this base command, is available:


Applied Parameters: None

Summary

This command is used to add a To-Do item to the active document. A To-Do item, as its name suggests, is basically used as a reminder for a task that needs to be carried out in relation to the document at a later stage.

Access

Right-click and choose Add To-Do Item from the context menu of a .txt file.

Use

First, ensure that the text cursor is placed at the point within the current document at which you wish to place the To-Do item.

After launching the command, the Edit To-Do Item dialog appears. Use this dialog to enter suitable text pertaining to the task that needs to be carried out at that point in the document. Use the available fields in the dialog to define a Priority for the task (ranging from Lowest to Highest, with Normal selected by default), the Owner of the task and also a Category for the task (e.g. Formatting pass, Code Review pass, etc).

After defining the To-Do item as required, clicking OK will close the dialog and return focus back to the current document. An entry for the To-Do item will appear at the point marked by the current text cursor position. The entry will appear  between { and } delimiters, as illustrated by the example below:

{TODO Name=Check Spelling|Priority=3|State=1|Owner=Jase|Category=Proofing|UID=UIDYOGFS}

Where:

  • Name is the actual text of the action to be taken.
  • Priority is a value representing the assigned priority (Lowest = 0, Low = 1, High = 3, Highest = 4). If the Priority has been set to Normal, an entry will not be displayed.
  • State reflects whether the Item has been done or not. If not, there will be no entry displayed. If done, the value for State will be 1.
  • Owner is the assigned owner of the item.
  • Category is the assigned category for the item.
  • UID is the unique identifier for that particular item.
Found an issue with this document? Highlight the area, then use Ctrl+Enter to report it.

Contact Us

Contact our corporate or local offices directly.

We're sorry to hear the article wasn't helpful to you.
Could you take a moment to tell us why?
200 characters remaining
You are reporting an issue with the following selected text
and/or image within the active document: