Working with Tags

Get Note Tag Details from OneNote Document

The NoteTag class provides all the properties related to a note tag in a Microsoft OneNote document. All the OneNote file’s note tags are contained by RichText nodes of the Document object.

The OneNote file displaying a note tag.

The code below shows how to get details about each note tag from the OneNote document.

String dataDir = Utils.getSharedDataDir(GetNodeTags.class) + "tags/";

// Load the document into Aspose.Note
Document doc = new Document(dataDir + "Sample1.one");

// Get all RichText nodes
List<RichText> nodes = doc.getChildNodes(RichText.class);

// Iterate through each node
for (RichText richText : nodes) {
	for (NoteTagCore tag : richText.getTags()) {
		if (tag.getClass() == NoteTag.class) {
			NoteTag noteTag = (NoteTag) tag;
			// Retrieve properties
			System.out.println("Completed Time: " + noteTag.getCompletedTime());
			System.out.println("Create Time: " + noteTag.getCreationTime());
			System.out.println("Font Color: " + noteTag.getFontColor());
			System.out.println("Status: " + noteTag.getStatus());
			System.out.println("Label: " + noteTag.getLabel());
			System.out.println("Icon: " + noteTag.getIcon());
			System.out.println("High Light: " + noteTag.getHighlight());
		}
	}
}

Tag Important Notes in the OneNote Document

The NoteTag class provides all the properties related to a note tag. Users can now tag text, image, and tables. Aspose.Note for Java API supports all these feature operations.

These articles show how to:

• Add a New Text Node with a Tag.
• Add a New Image Node with a Tag.
• Add a New Table Node with a Tag.

Add a New Text Node with a Tag

The code below shows how to add a new text node with a tag in the OneNote document.

// The path to the documents directory.
String dataDir = Utils.getSharedDataDir(AddTextNodeWithTag.class) + "tags/";

// Create an object of the Document class
Document doc = new Document();
// Initialize Page class object
Page page = new Page(doc);
// Initialize Outline class object
Outline outline = new Outline(doc);
// Initialize OutlineElement class object
OutlineElement outlineElem = new OutlineElement(doc);

ParagraphStyle textStyle = new ParagraphStyle();
textStyle.setFontColor(Color.BLACK);
textStyle.setFontName("Arial");
textStyle.setFontSize(10);

RichText text = new RichText(doc);
text.setText("OneNote text.");
text.setParagraphStyle(textStyle);

NoteTag noteTag = new NoteTag();
noteTag.setIcon(TagIcon.YellowStar);
text.getTags().addItem(noteTag);

// Add text node
outlineElem.appendChildLast(text);
// Add outline element node
outline.appendChildLast(outlineElem);
// Add outline node
page.appendChildLast(outline);
// Add page node
doc.appendChildLast(page);

dataDir = dataDir + "AddTextNodeWithTag_out.one";
// Save OneNote document
doc.save(dataDir);

Add a New Image Node with a Tag

The code below shows how to add a new Image node with a tag in the OneNote document.

String dataDir = Utils.getSharedDataDir(AddNewImageNodeWithTag.class) + "tags/";

// create an object of the Document class
Document doc = new Document();
// initialize Page class object
Page page = new Page(doc);
// initialize Outline class object
Outline outline = new Outline(doc);
// initialize OutlineElement class object
OutlineElement outlineElem = new OutlineElement(doc);
// load an image
Image image = new Image(doc, dataDir + "Input.jpg");
// insert image in the document node
outlineElem.appendChildLast(image);
NoteTag noteTag = new NoteTag();
noteTag.setIcon(TagIcon.YellowStar);
image.getTags().add(noteTag);

// add outline element node
outline.appendChildLast(outlineElem);
// add outline node
page.appendChildLast(outline);
// add page node
doc.appendChildLast(page);
// save OneNote document
doc.save(dataDir + "AddNewImageNodeWithTag_out.pdf", SaveFormat.Pdf);

Add a New Table Node with a Tag

The code below shows how to add a new Table node with a tag in the OneNote document.

String dataDir = Utils.getSharedDataDir(AddNewTableNodeWithTag.class) + "tags/";
// create an object of the Document class
Document doc = new Document();
// initialize Page class object
Page page = new Page(doc);
// initialize TableRow class object
TableRow row = new TableRow(doc);
// initialize TableCell class object
TableCell cell = new TableCell(doc);
// add cell to row node
row.appendChildLast(cell);
// initialize table node
Table table = new Table(doc);
table.setBordersVisible(true);
TableColumn column = new TableColumn();
column.setWidth(70);
table.getColumns().addItem(column);

// insert row node in table
table.appendChildLast(row);
// add tag to this table node
NoteTag noteTag = new NoteTag();
noteTag.setIcon(TagIcon.QuestionMark);
table.getTags().add(noteTag);

Outline outline = new Outline(doc);
OutlineElement outlineElem = new OutlineElement(doc);
// add table node
outlineElem.appendChildLast(table);
// add outline elements
outline.appendChildLast(outlineElem);
page.appendChildLast(outline);
doc.appendChildLast(page);
// save OneNote document
doc.save(dataDir + "AddNewTableNodeWithTag_out.pdf", SaveFormat.Pdf);