Class SmartArtShapeInfo

Represents the smart art shape info used by the presentation model.

Inheritance

object

SmartArtShapeInfo

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Namespace: DRIT.Presentation.Drawing

Assembly: DRIT.Presentation.dll

Syntax

public sealed class SmartArtShapeInfo

Properties

AllNodes

Gets a typed, read-only collection of all nodes in this SmartArt, in flat order.

Declaration

public SmartArtNodeCollection AllNodes { get; }

Property Value

Type	Description
SmartArtNodeCollection

ColorStyleId

Gets or sets the unique ID of the color style applied to this SmartArt.

Declaration

public string ColorStyleId { get; }

Property Value

Type	Description
string

ColorStyleName

Gets or sets the display name of the color style.

Declaration

public string ColorStyleName { get; }

Property Value

Type	Description
string

HasPendingLayoutFallback

Gets or sets whether has pending layout fallback is enabled.

Declaration

public bool HasPendingLayoutFallback { get; }

Property Value

Type	Description
bool

Layout

Gets the layout type of this SmartArt, mapped from the layout definition's unique ID. Returns Unknown when the layout is not recognized, or Custom when a non-built-in layout is used.

Declaration

public SmartArtLayoutType Layout { get; }

Property Value

Type	Description
SmartArtLayoutType

LayoutName

Gets or sets the display name of the SmartArt layout. Populated from the layout definition's title during read.

Declaration

public string LayoutName { get; }

Property Value

Type	Description
string

LayoutUniqueId

Gets or sets the layout unique id text.

Declaration

public string LayoutUniqueId { get; }

Property Value

Type	Description
string

MinimumVersion

Gets or sets the minimum version text.

Declaration

public string MinimumVersion { get; }

Property Value

Type	Description
string

Nodes

Gets the collection of nodes associated with this object.

Declaration

public IReadOnlyList<SmartArtNode> Nodes { get; }

Property Value

Type	Description
IReadOnlyList<SmartArtNode>

QuickStyleId

Gets or sets the unique ID of the quick style applied to this SmartArt.

Declaration

public string QuickStyleId { get; }

Property Value

Type	Description
string

QuickStyleName

Gets or sets the display name of the quick style.

Declaration

public string QuickStyleName { get; }

Property Value

Type	Description
string

RootNodes

Gets the collection of root nodes associated with this object.

Declaration

public IReadOnlyList<SmartArtNode> RootNodes { get; }

Property Value

Type	Description
IReadOnlyList<SmartArtNode>

Methods

AddRootNode(string, string)

Adds the root node to this smart art shape info.

Declaration

public SmartArtNode AddRootNode(string text, string nodeType = null)

Parameters

Type	Name	Description
string	text	The text supplied to this operation.
string	nodeType	The node type supplied to this operation.

Returns

Type	Description
SmartArtNode	The newly added rootnode.

GetNode(int)

Gets the node from this smart art shape info.

Declaration

public SmartArtNode GetNode(int index)

Parameters

Type	Name	Description
int	index	The zero-based index of the item.

Returns

Type	Description
SmartArtNode	The get node value produced by the operation.

MoveNode(string, string, int)

Handles move node for this smart art shape info.

Declaration

public bool MoveNode(string modelId, string newParentModelId, int insertionIndex = -1)

Parameters

Type	Name	Description
string	modelId	The identifier of the model to process.
string	newParentModelId	The new parent model id supplied to this operation.
int	insertionIndex	The insertion index supplied to this operation.

Returns

Type	Description
bool	true if the operation succeeds; otherwise, false.

RemoveNode(string)

Removes the node from this smart art shape info.

Declaration

public bool RemoveNode(string modelId)

Parameters

Type	Name	Description
string	modelId	The identifier of the model to process.

Returns

Type	Description
bool	true if the operation succeeds; otherwise, false.

SetNodeText(string, string)

Sets the node text for this smart art shape info.

Declaration

public bool SetNodeText(string modelId, string text)

Parameters

Type	Name	Description
string	modelId	The identifier of the model to process.
string	text	The text supplied to this operation.

Returns

Type	Description
bool	true if the operation succeeds; otherwise, false.

TryGetNode(string, out SmartArtNode)

Attempts to perform the get node and reports whether it succeeded.

Declaration

public bool TryGetNode(string modelId, out SmartArtNode node)

Parameters

Type	Name	Description
string	modelId	The identifier of the model to process.
SmartArtNode	node	The node supplied to this operation.

Returns

Type	Description
bool	true if the operation succeeds; otherwise, false.