SpecialChar Class |
Namespace: Aspose.Words
The SpecialChar type exposes the following members.
Name | Description | |
---|---|---|
![]() ![]() | Document |
Gets the document to which this node belongs.
(Inherited from Node.) |
![]() ![]() | Font |
Provides access to the font formatting of this object.
(Inherited from Inline.) |
![]() ![]() | IsComposite |
Returns true if this node can contain other nodes.
(Inherited from Node.) |
![]() ![]() | IsDeleteRevision |
Returns true if this object was deleted in Microsoft Word while change tracking was enabled.
(Inherited from Inline.) |
![]() ![]() | IsFormatRevision |
Returns true if formatting of the object was changed in Microsoft Word while change tracking was enabled.
(Inherited from Inline.) |
![]() ![]() | IsInsertRevision |
Returns true if this object was inserted in Microsoft Word while change tracking was enabled.
(Inherited from Inline.) |
![]() ![]() | IsMoveFromRevision |
Returns true if this object was moved (deleted) in Microsoft Word while change tracking was enabled.
(Inherited from Inline.) |
![]() ![]() | IsMoveToRevision |
Returns true if this object was moved (inserted) in Microsoft Word while change tracking was enabled.
(Inherited from Inline.) |
![]() ![]() | NextSibling |
Gets the node immediately following this node.
(Inherited from Node.) |
![]() ![]() | NodeType |
Returns NodeType.SpecialChar.
(Overrides NodeNodeType.) |
![]() ![]() | ParentNode |
Gets the immediate parent of this node.
(Inherited from Node.) |
![]() ![]() | ParentParagraph |
Retrieves the parent Paragraph of this node.
(Inherited from Inline.) |
![]() ![]() | PreviousSibling |
Gets the node immediately preceding this node.
(Inherited from Node.) |
![]() ![]() | Range |
Returns a Range object that represents the portion of a document that is contained in this node.
(Inherited from Node.) |
Name | Description | |
---|---|---|
![]() | Accept |
Accepts a visitor.
(Overrides NodeAccept(DocumentVisitor).) |
![]() ![]() | Clone | (Inherited from Node.) |
![]() | Equals | (Inherited from Object.) |
![]() ![]() | GetAncestor(Type) |
Gets the first ancestor of the specified object type.
(Inherited from Node.) |
![]() ![]() | GetAncestor(NodeType) |
Gets the first ancestor of the specified NodeType.
(Inherited from Node.) |
![]() | GetHashCode | (Inherited from Object.) |
![]() | GetText |
Gets the special character that this node represents.
(Overrides NodeGetText.) |
![]() | GetType | (Inherited from Object.) |
![]() ![]() | NextPreOrder |
Gets next node according to the pre-order tree traversal algorithm.
(Inherited from Node.) |
![]() ![]() | PreviousPreOrder |
Gets the previous node according to the pre-order tree traversal algorithm.
(Inherited from Node.) |
![]() ![]() | Remove |
Removes itself from the parent.
(Inherited from Node.) |
![]() | ToString | (Inherited from Object.) |
![]() ![]() | ToString(SaveFormat) |
Exports the content of the node into a string in the specified format.
(Inherited from Node.) |
![]() ![]() | ToString(SaveOptions) |
Exports the content of the node into a string using the specified save options.
(Inherited from Node.) |
A Microsoft Word document can include a number of special characters that represent fields, form fields, shapes, OLE objects, footnotes etc. For the list of special characters see ControlChar.
SpecialChar is an inline-node and can only be a child of Paragraph.
SpecialChar char is used as a base class for more specific classes that represent special characters that Aspose.Words provides programmatic access for. The SpecialChar class is also used itself to represent special character for which Aspose.Words does not provide detailed programmatic access.
public void RemoveHiddenContentFromDocument() { // Open the document we want to remove hidden content from. Document doc = new Document(MyDir + "Hidden content.docx"); // Create an object that inherits from the DocumentVisitor class RemoveHiddenContentVisitor hiddenContentRemover = new RemoveHiddenContentVisitor(); // This is the well known Visitor pattern. Get the model to accept a visitor // The model will iterate through itself by calling the corresponding methods // on the visitor object (this is called visiting) // We can run it over the entire the document like so doc.Accept(hiddenContentRemover); // Or we can run it on only a specific node Paragraph para = (Paragraph) doc.GetChild(NodeType.Paragraph, 4, true); para.Accept(hiddenContentRemover); // Or over a different type of node like below Table table = (Table) doc.GetChild(NodeType.Table, 0, true); table.Accept(hiddenContentRemover); doc.Save(ArtifactsDir + "Font.RemoveHiddenContentFromDocument.doc"); } /// <summary> /// This class when executed will remove all hidden content from the Document. Implemented as a Visitor. /// </summary> public class RemoveHiddenContentVisitor : DocumentVisitor { /// <summary> /// Called when a FieldStart node is encountered in the document. /// </summary> public override VisitorAction VisitFieldStart(FieldStart fieldStart) { // If this node is hidden, then remove it. if (IsHidden(fieldStart)) fieldStart.Remove(); return VisitorAction.Continue; } /// <summary> /// Called when a FieldEnd node is encountered in the document. /// </summary> public override VisitorAction VisitFieldEnd(FieldEnd fieldEnd) { if (IsHidden(fieldEnd)) fieldEnd.Remove(); return VisitorAction.Continue; } /// <summary> /// Called when a FieldSeparator node is encountered in the document. /// </summary> public override VisitorAction VisitFieldSeparator(FieldSeparator fieldSeparator) { if (IsHidden(fieldSeparator)) fieldSeparator.Remove(); return VisitorAction.Continue; } /// <summary> /// Called when a Run node is encountered in the document. /// </summary> public override VisitorAction VisitRun(Run run) { if (IsHidden(run)) run.Remove(); return VisitorAction.Continue; } /// <summary> /// Called when a Paragraph node is encountered in the document. /// </summary> public override VisitorAction VisitParagraphStart(Paragraph paragraph) { if (IsHidden(paragraph)) paragraph.Remove(); return VisitorAction.Continue; } /// <summary> /// Called when a FormField is encountered in the document. /// </summary> public override VisitorAction VisitFormField(FormField formField) { if (IsHidden(formField)) formField.Remove(); return VisitorAction.Continue; } /// <summary> /// Called when a GroupShape is encountered in the document. /// </summary> public override VisitorAction VisitGroupShapeStart(GroupShape groupShape) { if (IsHidden(groupShape)) groupShape.Remove(); return VisitorAction.Continue; } /// <summary> /// Called when a Shape is encountered in the document. /// </summary> public override VisitorAction VisitShapeStart(Shape shape) { if (IsHidden(shape)) shape.Remove(); return VisitorAction.Continue; } /// <summary> /// Called when a Comment is encountered in the document. /// </summary> public override VisitorAction VisitCommentStart(Comment comment) { if (IsHidden(comment)) comment.Remove(); return VisitorAction.Continue; } /// <summary> /// Called when a Footnote is encountered in the document. /// </summary> public override VisitorAction VisitFootnoteStart(Footnote footnote) { if (IsHidden(footnote)) footnote.Remove(); return VisitorAction.Continue; } /// <summary> /// Called when visiting of a Table node is ended in the document. /// </summary> public override VisitorAction VisitTableEnd(Table table) { // At the moment there is no way to tell if a particular Table/Row/Cell is hidden. // Instead, if the content of a table is hidden, then all inline child nodes of the table should be // hidden and thus removed by previous visits as well. This will result in the container being empty // so if this is the case we know to remove the table node. // // Note that a table which is not hidden but simply has no content will not be affected by this algorithm, // as technically they are not completely empty (for example a properly formed Cell will have at least // an empty paragraph in it) if (!table.HasChildNodes) table.Remove(); return VisitorAction.Continue; } /// <summary> /// Called when visiting of a Cell node is ended in the document. /// </summary> public override VisitorAction VisitCellEnd(Cell cell) { if (!cell.HasChildNodes && cell.ParentNode != null) cell.Remove(); return VisitorAction.Continue; } /// <summary> /// Called when visiting of a Row node is ended in the document. /// </summary> public override VisitorAction VisitRowEnd(Row row) { if (!row.HasChildNodes && row.ParentNode != null) row.Remove(); return VisitorAction.Continue; } /// <summary> /// Called when a SpecialCharacter is encountered in the document. /// </summary> public override VisitorAction VisitSpecialChar(SpecialChar specialChar) { if (IsHidden(specialChar)) specialChar.Remove(); return VisitorAction.Continue; } /// <summary> /// Returns true if the node passed is set as hidden, returns false if it is visible. /// </summary> private static bool IsHidden(Node node) { switch (node) { case Inline currentNode: // If the node is Inline then cast it to retrieve the Font property which contains the hidden property return currentNode.Font.Hidden; default: switch (node.NodeType) { case NodeType.Paragraph: { // If the node is a paragraph cast it to retrieve the ParagraphBreakFont which contains the hidden property Paragraph para = (Paragraph) node; return para.ParagraphBreakFont.Hidden; } default: switch (node) { case ShapeBase shape: // Node is a shape or groupshape return shape.Font.Hidden; case InlineStory inlineStory: // Node is a comment or footnote return inlineStory.Font.Hidden; } break; } break; } // A node that is passed to this method which does not contain a hidden property will end up here // By default nodes are not hidden so return false return false; } }