Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

GetOneWayLayout


...

Function used to perform segment layouts at a specified span, horizontal run, as well as spacing.

...


Syntax:

Procedure: GetOneWayLayout(const AItem: WideString; const sSpanHint: WideString; const sRunHint: WideString; bIncludeFirst: WordBool; bIncludeLast: WordBool; nSpacing: Double; const AArea: WideString): WordBool;

Arguments: 
AItem: WideString
Specifies the area section to assign the layout segments to.

sSpanHint: WideString
Hint to user on mouse cursor specifying to select the span line.

sRunHint: WideString
Hint to user on mouse cursor specifying to select the run line.

bIncludeFirst: WordBool
Specifies whether to include a segment at the "start" run point. Even if it does not fall within the spacing range.

bIncludeLast: WordBool
Specifies whether to include a segment at the "last" run point. Even if it does not fall within the spacing range.

nSpacing: Double
Specifies the "run" spacing used when laying out segment objects.

AArea: WideString (optional parameter)
Specifies a defined "Area Segment" to trim/extend laid segments to. Supply either the path or GUID to the area section. Or, empty double-quotes for no trim/extending required.


Code Reference:

    1. Create a New Form application
    2. Add a button to the form
    3. Add PlanSwift to reference (Planswift9_tlb in the uses)
    4. Copy code to button onclick event


API Call: