buttonbar.getActiveSegmentContent ( buttonBarObjectName ; optional_listButtonBarSegments )

Returns the text label (i.e., `content`) of the Button Bar Segment that is active. Useful for determining which button a user clicked.

Average rating: 4.8 (13 votes) Log in to vote

Cristos Lianides-Chin - Show more from this author
Codence
https://www.codence.com

Sample input:

buttonbar.getActiveSegmentContent ( "headerNavigation_ButtonList" ; "" )

Sample output:

"Customer Orders"

Function definition: (Copy & paste into FileMaker's Edit Custom Function window)

/** 

# buttonbar.getActiveSegmentContent ( buttonBarObjectName ; optional_listButtonBarSegments ) 
## v1.0.0 2016-09-07
Returns the text label (i.e., `content`) of the Button Bar Segment that is active. Useful for determining which button a user clicked.


## USAGE
    buttonbar.getActiveSegmentContent ( "headerNavigation_ButtonList" ; "" )


## PARAMETERS
### buttonBarObjectName
 - The name (from the Inspector) of the Button Bar layout object.
### optional_listButtonBarSegments
 - Used for recursion, generally should be omitted (see "USAGE" below). 


## RETURNS
 - The text label given to the button bar segment, e.g. `"Customer Orders"`.


## REQUIRES
 - Button Bar must have a name in the Inspector
 - Each Segment of the Button Bar must have a name in the inspector


## CHANGELOG
### [2016-09-07 cristos@anchorbuoysoftware.com](http://www.anchorbuoysoftware.com)
 - Function created
 - Based on suggestions from https://fmslug.slack.com/archives/general/p1473279629000181 by [Tony White](http://www.twdesigns.com)

**/

Let (
[   ~buttonBar = buttonBarObjectName
;   ~listButtonBarSegments = Case 
	(	IsEmpty ( optional_listButtonBarSegments )
	;		GetLayoutObjectAttribute ( ~buttonBar ; "containedObjects" )
	/**	ELSE **/
	;		optional_listButtonBarSegments
	)

;	~currentButtonBarSegment = GetValue ( ~listButtonBarSegments ; 1 ) /** Get the top-most segment in the list. **/
;	~isActiveSegment = GetLayoutObjectAttribute ( ~currentButtonBarSegment ; "isActive" )

;	~value = Case 
	(	~isActiveSegment
	;		GetLayoutObjectAttribute ( ~currentButtonBarSegment ; "content" ) /** If we detected the current segment is active, return its contents. **/
	/**	ELSE **/
	;		Let (	/** Otherwise, reduce the list and recursively try again. **/
			[	~countButtonBarSegments_next = ValueCount ( ~listButtonBarSegments ) - 1
			;	~listButtonBarSegments_next = RightValues ( ~listButtonBarSegments ; ~countButtonBarSegments_next )
			;	~value = Case 
				(	~countButtonBarSegments_next > 0
				;		buttonbar.getActiveSegmentContent ( ~buttonBar ; ~listButtonBarSegments_next )
				/**	ELSE **/
				;		"? - No active button bar segment could be found."
				)
			]
			;	~value
			)
	)
]
;	~value
)

# buttonbar.getActiveSegmentContent ( buttonBarObjectName ; optional_listButtonBarSegments )
## v1.0.0 2016-09-07
Returns the text label (i.e., `content`) of the Button Bar Segment that is active. Useful for determining which button a user clicked.

## USAGE
buttonbar.getActiveSegmentContent ( "headerNavigation_ButtonList" ; "" )

## PARAMETERS
### buttonBarObjectName
- The name (from the Inspector) of the Button Bar layout object.
### optional_listButtonBarSegments
- Used for recursion, generally should be omitted (see "USAGE" below).

## RETURNS
- The text label given to the button bar segment, e.g. `"Customer Orders"`.

## REQUIRES
- Button Bar must have a name in the Inspector
- Each Segment of the Button Bar must have a name in the inspector

## CHANGELOG
### [2016-09-07 cristos@anchorbuoysoftware.com](http://www.anchorbuoysoftware.com)
- Function created
- Based on suggestions from https://fmslug.slack.com/archives/general/p1473279629000181 by [Tony White](http://www.twdesigns.com)

Comments

Note: these functions are not guaranteed or supported by BrianDunning.com. Please contact the individual developer with any questions or problems.

buttonbar.getActiveSegmentContent ( buttonBarObjectName ; optional_listButtonBarSegments )

Comments

Support this website.

Support this website.