Not logged in▾
Log In Register
Forgot Password Resend Validation E-mail

OutliningNodeDefinition Class

In This Article
Namespace:
ActiproSoftware.Windows.Controls.SyntaxEditor.Outlining.Implementation
Assembly:
ActiproSoftware.SyntaxEditor.Wpf.dll

Represents a definition used to create an outlining node.

public class OutliningNodeDefinition : IOutliningNodeDefinition, IKeyedObject
Inheritance:
object object
Implements:
IOutliningNodeDefinition IKeyedObject

Constructors

OutliningNodeDefinition(string)

Initializes the OutliningNodeDefinition class.

public OutliningNodeDefinition(string key)
Parameter Type Description
key string

The string-based key that identifies the object.

Properties

DefaultCollapsedContent

Gets or sets the default content that should be displayed when the outlining node is collapsed.

public object DefaultCollapsedContent { get; set; }

Property Value

object:

The default content that should be displayed when the outlining node is collapsed.

Remarks

Only string-based content is currently supported. This property may be left null to use the global default collapsed content.

HasEndDelimiter

Gets or sets whether the outlining node ends using a delimiter.

public bool HasEndDelimiter { get; set; }

Property Value

bool:

true if the outlining node ends using a delimiter; otherwise, false.

Remarks

This property can be set to false to hint to the outlining manager that the node might be properly closed even though it doesn't have an end delimiter.

IsCollapsible

Gets or sets whether the outlining node is capable of being collapsed.

public bool IsCollapsible { get; set; }

Property Value

bool:

true if the outlining node is capable of being collapsed; otherwise, false.

IsDefaultCollapsed

Gets or sets whether the outlining node is collapsed by default.

public bool IsDefaultCollapsed { get; set; }

Property Value

bool:

true if the outlining node is collapsed by default; otherwise, false.

Remarks

Pre-processor region nodes are examples of nodes that are generally collapsed by default.

IsImplementation

Gets or sets whether the outlining node represents some sort of member implementation that should be auto-collapsed when collapsing to definitions.

public bool IsImplementation { get; set; }

Property Value

bool:

true if the outlining node represents some sort of member implementation; otherwise, false.

Key

Gets the string-based key that identifies the object.

public string Key { get; }

Property Value

string:

The string-based key that identifies the object.

Methods

GetCollapsedContent(IOutliningNode)

Returns the content that should be displayed when the outlining node is collapsed.

public virtual object GetCollapsedContent(IOutliningNode node)
Parameter Type Description
node IOutliningNode

The IOutliningNode, based on this definition, for which content is requested.

Returns

object:

The content that should be displayed when the outlining node is collapsed.

Remarks

Only string-based content is currently supported. The default implementation of this method returns the value of the DefaultCollapsedContent property. This method can be overridden to generate unique collapsed content for a particular node.

ToString()

Returns a String that represents the current Object.

public override string ToString()

Returns

string:

A String that represents the current Object.

Inherited Members