CurrentDetail

Returns or changes the current detail view in a page layout view.

Syntax

rhinoscriptsyntax.CurrentDetail (layout, detail=None, return_name=True)

rhinoscript.view.CurrentDetail (layout, detail=None, return_name=True)

Parameters

layout

Required.  String or Guid.  The title or identifier of an existing page layout view.

detail

Optional.  String or Guid.  The title identifier of the detail view to set current.  If omitted, identifier of the current detail view is returned.  Note, if no detail views are active, then the title or identifier of the page layout view is returned. Also, to set the page layout view current, simply use layout as the value you pass to detail.

return_name

Optional.  Boolean.  If True (default), then the name, or title, of the detail view is returned. If False, then the identifier of the detail view is returned.

Returns

String or Guid

If detail is not specified, the title or identifier of the current detail view if successful.

String or Guid

If detail is specified, the title or identifier of the previous current detail view is successful.

None

If not successful, or on error.

Example

import rhinoscriptsyntax as rs

layout = rs.CurrentView(return_name=False)

if rs.IsLayout(layout):

    rs.CurrentDetail( layout, layout )

Also See

IsDetail

IsLayout