API Reference
Class
RtfShape
Dependency-free representation of an RTF drawing shape, including raw instructions, named properties, and optional text-box content.
Inheritance
- Object
- RtfShape
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method RtfDocument.AddShape
- Method RtfParagraph.AddShape
Constructors
public RtfShape() #Methods
public RtfShapeInstruction AddInstruction(String name, Nullable<Int32> parameter = null, Boolean hasParameter = true) #Returns:
RtfShapeInstructionAdds a raw shape instruction control.
Parameters
- name System.String
- parameter System.Nullable{System.Int32} = null
- hasParameter System.Boolean = true
public RtfShapeProperty AddProperty(String name, String value = null) #Returns:
RtfShapePropertyAdds a named shape property.
Parameters
- name System.String
- value System.String = null
public RtfParagraph AddTextBoxParagraph(String text = null) #Returns:
RtfParagraphAdds a paragraph to the shape text box.
Parameters
- text System.String = null
public String ToPlainText() #Returns:
StringReturns text-box content with paragraphs separated by new lines.
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
Properties
public IReadOnlyList<RtfShapeInstruction> Instructions { get; } #Raw shape instruction controls from \shpinst.
public IReadOnlyList<RtfShapeProperty> Properties { get; } #Named shape properties from \sp groups.
public IReadOnlyList<RtfParagraph> TextBoxParagraphs { get; } #Paragraphs contained by the shape text box destination.