Method Outline

Namespace

Alternet.Editor

Assembly

Alternet.Editor.v10.dll

Outline(int, int, int)

This method creates an outlining section based on specific scope at the specific level of outline nesting.

public virtual IOutlineRange Outline(int first, int last, int level)

Parameters

first int

Specifies first line of section to outline.

last int

Specifies last line of section to outline.

level int

Specifies level of outline nesting for this section.

Returns

IOutlineRange

IOutlineRange object that represents outline section, If AllowOutlining property is true; otherwise return null.

Remarks

This method is applicable only when property AllowOutlining is true.

Outline(int, int)

This method creates an outlining section based on specific scope.

public virtual IOutlineRange Outline(int first, int last)

Parameters

first int

Specifies first line of section to outline.

last int

Specifies last line of section to outline.

Returns

IOutlineRange

IOutlineRange object that represents outline section, if AllowOutlining property is true ; otherwise return null.

Remarks

This method is applicable only when property AllowOutlining is true.

Outline(Point, Point, int)

This method creates an outlining section based on specific scope with the specific level of outline nesting.

public virtual IOutlineRange Outline(Point startPoint, Point endPoint, int level)

Parameters

startPoint Point

Specifies begin of section to outline.

endPoint Point

Specifies end of section to outline.

level int

Specifies level of outline nesting for this section.

Returns

IOutlineRange

IOutlineRange object that represents outline section, if AllowOutlining property is true ; otherwise return null.

Remarks

This method is applicable only when property AllowOutlining is true.

Outline(Point, Point)

This method creates an outlining section based on specific scope.

public virtual IOutlineRange Outline(Point startPoint, Point endPoint)

Parameters

startPoint Point

Specifies begin of section to outline.

endPoint Point

Specifies end of section to outline.

Returns

IOutlineRange

IOutlineRange object that represents outline section, if AllowOutlining property is true ; otherwise return null.

Remarks

This method is applicable only when property AllowOutlining is true.

Outline(int, int, int, string)

This method creates an outlining section based on specific scope at specific level of outline nesting and with specific text substituting collapsed section.

public virtual IOutlineRange Outline(int first, int last, int level, string outlineText)

Parameters

first int

Specifies first line of section to outline.

last int

Specifies last line of section to outline.

level int

Specifies level of outline nesting for this section.

outlineText string

Specifies text displayed when outline section is collapsed.

Returns

IOutlineRange

IOutlineRange object that represents outline section, if AllowOutlining property is true; otherwise return null.

Remarks

This method is applicable only when property AllowOutlining is true.

Outline(int, int, string)

This method creates an outlining section based on specific scope within current outlined section and with specific text substituting collapsed section.

public virtual IOutlineRange Outline(int first, int last, string outlineText)

Parameters

first int

Specifies first line of section to outline.

last int

Specifies last line of section to outline.

outlineText string

Specifies text displayed when outline section is collapsed.

Returns

IOutlineRange

IOutlineRange object that represents outline section, if AllowOutlining property is true; otherwise return null.

Remarks

This method is applicable only when property AllowOutlining is true.

Outline(Point, Point, int, string)

This method creates an outlining section based on specific scope with specific level of outline nesting and specific text substituting collapsed section.

public virtual IOutlineRange Outline(Point startPoint, Point endPoint, int level, string outlineText)

Parameters

startPoint Point

Specifies begin of section to outline.

endPoint Point

Specifies end of section to outline.

level int

Specifies level of outline nesting for this section.

outlineText string

Specifies text displayed when outline section is collapsed.

Returns

IOutlineRange

IOutlineRange object that represents outline section, if AllowOutlining property is true; otherwise return null.

Remarks

This method is applicable only when property AllowOutlining is true.

Outline(Point, Point, string)

This method creates an outlining section based on specific scope within current outlined section and with specific text substituting collapsed section.

public virtual IOutlineRange Outline(Point startPoint, Point endPoint, string outlineText)

Parameters

startPoint Point

Specifies begin of section to outline.

endPoint Point

Specifies end of section to outline.

outlineText string

Specifies text displayed when outlined section is collapsed.

Returns

IOutlineRange

IOutlineRange object that represents outline section, if AllowOutlining property is true; otherwise return null.

Remarks

This method is applicable only when property AllowOutlining is true.