Class Outlining

Namespace: Alternet.Editor

Assembly: Alternet.Editor.v9.dll

Represents properties and methods that affects appearance and behaviour of outline sections within Edit control.

public class Outlining : IOutlining, ICollapsable

Inheritance: object

Outlining

Implements: IOutlining

ICollapsable

Constructors

Outlining(ISyntaxEdit): Initializes a new instance of the Outlining class with a specified owner.

Properties

AllowOutlining: Gets or sets a value indicating whether outlining enabled.

CollapsedCount: Returns number of collapsed sections.

CollapsedLineColor: Gets or sets color that is used to draw collapsed line.

ImageSize: Gets or sets size of outlining image. When auto scaling enabled, measured in DIP.

ImageSizeInPixels: When implemented by a class, gets size of outlining image in pixels.

OutlineCollapsedImageIndex: Gets or sets image index to draw outline button in the collapsed state.

OutlineColor: Gets or sets color that is used to draw outline button.

OutlineExpandedImageIndex: Gets or sets image index to draw outline button in the expanded state.

OutlineOptions: Gets or sets outlining options.

UpdateCount

UseRoundRect: Gets or sets a boolean value indicating whether outlining buttons should be drawn with rounded corners.

Methods

Assign(IOutlining): Copies the contents from another IOutlining object.

BeginUpdate(): Prevents outline list updating until calling EndUpdate method.

CanCollapse(int): Returns boolean value indicating that outline section at given line can be collapsed.

CanExpand(IOutlineRange): Returns boolean value indicating that given outline section can be expanded.

CanExpand(int): Returns boolean value indicating that outline section at given line can be expanded.

Collapse(int): Collapses the specified line.

CollapseToDefinitions(): Collapses and expands some outline section to get a quick overall view of the content.

EndUpdate(): Re-enables outline list updating, that was turn of by calling BeginUpdate method.

EnsureExpanded(Point): Makes all outline sections containing specified position expanded.

EnsureExpanded(int): Makes all outline sections containing specified line expanded.

Expand(int): Expands outline section at the given line.

FullCollapse(): When implemented by a class, collapses all outlining sections.

FullCollapse(IList<IRange>): Collapses all sections objects specified by Ranges parameter.

FullExpand(): Expands all outlining sections.

FullExpand(IList<IRange>): Expands all outline sections specified by Ranges parameter.

GetOutlineHint(IOutlineRange): Returns string that appears in the hint window when mouse pointer is over the outline button.

GetOutlineRange(Point): Returns outline section, which represents text substituting outlined section and level of outline nesting at the specific position.

GetOutlineRange(int): Returns outline section, which represents text substituting outlined section and level of outline nesting at the specific line.

GetOutlineRanges(IList<IRange>): Fills list specified by ranges parameter with all existing outline sections.

GetOutlineRanges(IList<IRange>, Point): Fills list specified by ranges parameter with all outline sections containing specific position.

GetOutlineRanges(IList<IRange>, Point, Point): Fills list specified by ranges parameter with all outline sections containing specific range.

GetOutlineRanges(IList<IRange>, int): Fills list specified by ranges parameter with all outline sections containing specific line.

IsCollapsed(int): Indicates whether the outlined text at the specified line is collapsed.

IsExpanded(int): Indicates whether the outlined text at the specified line is expanded.

IsVisible(Point): Indicates whether the text at the specified position is visible, that is there is no collapsed outline section containing given position.

IsVisible(int): Indicates whether the text at the specified line is visible, that is there is no collapsed outline section containing given line.

OnCollapsedLineColorChanged()

OnImageSizeChanged()

OnOutlineColorChanged()

OnUseRoundRectChanged()

Outline(Point, Point): Creates an outlining section based on specific scope within current outlined section.

Outline(Point, Point, int): Creates an outlining section based on specific scope at the specific level of outline nesting.

Outline(Point, Point, int, string): Creates an outlining section based on specific scope at specific level of outline nesting and with specific text substituting collapsed text.

Outline(Point, Point, string): Creates an outlining section based on specific scope within current outlined section and with specific text substituting collapsed text.

Outline(int, int): Creates an outlining section based on specific scope within current outlined section.

Outline(int, int, int): Creates an outlining section based on specific scope at the specific level of outline nesting.

Outline(int, int, int, string): Creates an outlining section based on specific scope at specific level of outline nesting and with specific text substituting collapsed text.

Outline(int, int, string): Creates an outlining section based on specific scope within current outlined section and with specific text substituting collapsed text.

OutlineText(): Tries to perform lexical analysis of entire text to create outline sections based on results of this analysis.

ResetAllowOutlining(): Resets AllowOutlining to the default value.

ResetCollapsedLineColor(): Resets CollapsedLineColor to the default value.

ResetOutlineColor(): Resets OutlineColor to the default value.

ResetOutlineOptions(): Resets OutlineOptions to the default value.

SetOutlineRanges(IList<IRange>): Updates IOutlineRange collection from given list of ranges.

SetOutlineRanges(IList<IRange>, bool): Updates IOutlineRange collection from given list of ranges.

ShouldSerializeCollapsedLineColor(): Indicates whether the OutlineColor property should be persisted.

ShouldSerializeImageSize(): Indicates whether the ImageSize property should be persisted.

ShouldSerializeOutlineColor(): Indicates whether the OutlineColor property should be persisted.

ShouldSerializeOutlineOptions(): Indicates whether the OutlineOptions property should be persisted.

ToggleOutlining(): Toggles expanded state for all IOutlineRange objects in outline collection.

ToggleOutlining(IList<IRange>, IOutlineRange): Toggles expanded state for given IOutlineRange collection.

UnOutline(): Removes all outlined sections from outline collection.

UnOutline(Point): Removes outlined section at the specific position.

UnOutline(int): Removes all outline sections containing the given line.

UnOutlineText(): Removes all outline section from outline collection.

Events

Collapsing: Occurs when user attempts expand outline section.

Expanding: Occurs when user attempts expand outline section.