In this article, we will learn how to create android Toggle Button programmatically in Kotlin. We will go through various steps that explains how to create Toggle Button and add it in kotlin file, use different attributes to customise it etc. in any android application. For example, how to set text in Toggle Button programmatically, how to set id of Toggle Button, how to capitalise text of Toggle Button dynamically etc. We will get answer to all such questions in this post.

Learn to use Different Attributes of Toggle Button in XML File to Customize it.

Output

Tutorialwing android dynamic toggle button output

Getting Started

We can define android Toggle Button widget as below –

Android toggle button is a widget that are used to display two states(checked/unchecked or ON/OFF) as a button with light indicator and default text ON or OFF.

Now, how do we use Toggle Button in android application ?

Before we move ahead, we need to setup for viewBinding to access Toggle Button in Kotlin file without using findViewById() method.

Setup ViewBinding

Add viewBinding true in app/build.gradle file.

 
 android { 
 	// OTHER CODE... 
 	buildFeatures { 
 		viewBinding true 
 	} 
 } 
 

Now, set content in activity using view binding.
Open MainActivity.kt file and write below code in it.

 
 class MainActivity : AppCompatActivity() { 
 	
 	private lateinit var binding: ActivityMainBinding 
 	
 	override fun onCreate(savedInstanceState: Bundle?) { 
 		super.onCreate(savedInstanceState) 
 		binding = ActivityMainBinding.inflate(layoutInflater) 
 		val view = binding.root 
 		setContentView(view) 
 	} 
 } 
 

Now, we can access view in Kotlin file without using findViewById() method.

Since we have a new project, we will modify the xml and class file to use Toggle Button programmatically in kotlin. Please follow the steps below.

2. Modify Values Folder

Open res/values/strings.xml file. Add below code into it.

<resources>
    <string name="app_name">DynamicToggleButton</string>
</resources>

Other values folders have not been changed. So, we are not going to mention it here.

3. Modify Layout Folder

Open res/layout/activity_main.xml file. Add below code into it.

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout
    android:id="@+id/rootContainer"
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:gravity="center"
    android:orientation="vertical">

</LinearLayout>

Note that LinearLayout has id rootLayout. In Kotlin file, we will create Toggle Button Dynamically and add it into this LinearLayout having id rootLayout.

4. Create Android Toggle Button programmatically in Kotlin

Open src/main/java/com.tutorialwing.dynamictogglebuttonMainActivity.kt file. Then, add below code into it.

package com.tutorialwing.dynamictogglebutton

import androidx.appcompat.app.AppCompatActivity
import android.os.Bundle
import android.view.Gravity
import android.view.ViewGroup
import android.widget.LinearLayout
import android.widget.ToggleButton
import com.tutorialwing.dynamictogglebutton.databinding.ActivityMainBinding

class MainActivity : AppCompatActivity() {

	private lateinit var binding: ActivityMainBinding

	override fun onCreate(savedInstanceState: Bundle?) {
		super.onCreate(savedInstanceState)
		binding = ActivityMainBinding.inflate(layoutInflater)
		val view = binding.root
		setContentView(view)

		addToggleButton()
	}

	private fun addToggleButton() {
		// Create ToggleButton programmatically.
		val toggleButton = ToggleButton(this)
		toggleButton.layoutParams = LinearLayout.LayoutParams(
			ViewGroup.LayoutParams.WRAP_CONTENT,
			ViewGroup.LayoutParams.WRAP_CONTENT
		)
		toggleButton.gravity = Gravity.CENTER
		toggleButton.textOn = "ON"
		toggleButton.textOff = "OFF"

		// Add ToggleButton to LinearLayout
		binding.rootContainer.addView(toggleButton)
	}
}

Finally, when you run the application, you will get output as shown above.

Tutorialwing android dynamic toggle button output

Now, Let’s check how to use different attributes of Toggle Button to customize it dynamically –

Set Id of Toggle Button

Follow steps below to set id of Toggle Button programmatically –

• Create ids.xml file in res/values folder. Then, add below code into it –

  <?xml version="1.0" encoding="utf-8"?>
  <resources>
      <item type="id" name="ToggleButton_ID" />
  </resources>
  

• Now, we can set id of Toggle Button dynamically, in MainActivity.kt file, as –

  toggleButton.id = R.id.ToggleButton_ID  // Toggle Button ID
  

  Here, we have set id of Toggle Button using property access syntax – toggleButton.id

Learn to Set ID of Toggle Button Using XML Attribute

Set Width and Height of Toggle Button

We use layoutParams to set width and height of any View programmatically. In this article, we have added Toggle Button in LinearLayout. So, we will define LayoutParams as below –

toggleButton.layoutParams = LinearLayout.LayoutParams(
	ViewGroup.LayoutParams.WRAP_CONTENT,
	ViewGroup.LayoutParams.WRAP_CONTENT
)

Here, we have set width and height as WRAP_CONTENT. Some of possible values for width and height are –

• WRAP_CONTENT: Sets value of width or height depending on text inside it.
• MATCH_PARENT: Sets value of width of height depending on width or height of parent layout . i.e. width or height of Toggle Button will be same as width or height of parent layout.
• Fixed Value: Sets width or height as per value provided.

Learn to Set Width or Height of Toggle Button Using XML Attribute

Set Padding of Toggle Button

Follow steps below to set padding of Toggle Button Dynamically –

• If there is no dimens.xml file, create dimens.xml file in res/values folder. Then, add below code in it –

  <?xml version="1.0" encoding="utf-8"?>
  <resources>
      <dimen name="text_padding">16dp</dimen>
  </resources>
  

• Now, we can set padding of Toggle Button dynamically, in MainActivity.kt file, as –

  val padding = resources.getDimension(R.dimen.text_padding).toInt()
  toggleButton.setPadding(padding, padding, padding, padding)
  

  Here, we have accessed dimension defined in dimens.xml using getDimension() method. Then, set padding of Toggle Button using setPadding() method.

Learn to Set Padding of Toggle Button Using XML Attribute

Set Margin of Toggle Button

Follow steps below to set margin of Toggle Button Dynamically –

• If there is no dimens.xml file, create dimens.xml file in res/values folder. Then, add below code in it –

  <?xml version="1.0" encoding="utf-8"?>
  <resources>
      <dimen name="text_margin">16dp</dimen>
  </resources>
  

• Now, we can set margin of Toggle Button dynamically, in MainActivity.kt file, as –

  val margin = resources.getDimension(R.dimen.text_margin).toInt()
  val layoutParams = LinearLayout.LayoutParams(
  	ViewGroup.LayoutParams.WRAP_CONTENT,
  	ViewGroup.LayoutParams.WRAP_CONTENT
  )
  layoutParams.setMargins(margin, margin, margin, margin)
  toggleButton.layoutParams = layoutParams
  

  Here, we have accessed dimension defined in dimens.xml using getDimension() method. Then, we have defined layoutParams, set margin to layoutParams. After that, set layoutParams to ToggleButton

Learn to Set Margin of Toggle Button Using XML Attribute

Set Background of Toggle Button

Follow steps below to set background of Toggle Button programmatically –

• If there is no colors.xml file, create colors.xml file in res/values folder. Then, add below code in it –

  <?xml version="1.0" encoding="utf-8"?>
  <resources>
      <color name="purple_200">#FFBB86FC</color>
  </resources>
  

• Now, we can set background of Toggle Button dynamically, in MainActivity.kt file, as –

  val color = ContextCompat.getColor(this, R.color.purple_200)
  toggleButton.setBackgroundColor(color)
  

  Here, we used setBackgroundColor() method to set background color in toggleButton.

Learn to Set Background of Toggle Button Using XML Attribute

Set Visibility of Toggle Button

We can set visibility of Toggle Button programmatically as –

toggleButton.visibility = View.VISIBLE

Here, we have set visibility of Toggle Button using toggleButton.visibility attribute. Visibility can be of three types – gone, visible and invisible.
Learn to Set Visibility of Toggle Button Using XML Attribute

Set Text of Toggle Button

Follow steps below to set text of Toggle Button programmatically –

• If there is no strings.xml file, create strings.xml file in res/values folder. Then, add below code in it –

  <resources>
      <string name="click_on_me">Click on me</string>
  </resources>
  

• Now, we can set text of Toggle Button dynamically, in MainActivity.kt file, as –

  toggleButton.text = getString(R.string.click_on_me)
  

  Here, we used toggleButton.text to set text in toggleButton.

• We can also use toggleButton.textOn and toggleButton.textOff to set text in toggle button when it is ON and OFF states respectively. We can do it as below –

  toggleButton.textOn = "ON"
  toggleButton.textOff = "OFF"
  

Learn to Set Text of Toggle Button Using XML Attribute

Set Color of Text of Toggle Button

Follow steps below to set color of text of Toggle Button programmatically in Kotlin –

• If there is no colors.xml file, create colors.xml file in res/values folder. Then, add below code in it –

  <?xml version="1.0" encoding="utf-8"?>
  <resources>
      <color name="black">#FF000000</color>
  </resources>
  

• Now, we can set color of text of Toggle Button dynamically, in MainActivity.kt file, as –

  val textColor = ContextCompat.getColor(this, R.color.black)
  toggleButton.setTextColor(textColor)
  

  Here, we used setTextColor() method to set color of Toggle Button of toggleButton.

Learn to Set Color of Toggle Button Using XML Attribute

Set Gravity of Toggle Button

We can set gravity of text of Toggle Button programmatically in Kotlin as –

toggleButton.gravity = Gravity.CENTER

Here, we have set gravity of Toggle Button as center. So, all the text of Toggle Button will be center aligned.
We can also apply multiple gravity values as –

toggleButton.gravity = Gravity.CENTER_HORIZONTAL or Gravity.BOTTOM

Here, we have applied multiple gravity values, in Kotlin, to ToggleButton In above case, text will be aligned as horizontally centered to bottom.
Learn to Set Margin of Toggle Button Using XML Attribute

Set Text in Uppercase or Lowercase

Follow steps below to set text in uppercase or lowercase programmatically as –

• Set Text in Uppercase

  We use toggleButton.isAllCaps attributes to set text in uppercase or normal. If it is true, text will be set in uppercase.

  toggleButton.text = "Hello Tutorialwing"
  toggleButton.isAllCaps = true
  

  In Above case, “Hello Tutorialwing” will be set in Uppercase to ToggleButton So, text will be “HELLO TUTORIALWING”.

• By default, isAllCaps is false. So, whatever is written, text will be set as it is. For example,

  toggleButton.text = "Hello Tutorialwing"
  toggleButton.isAllCaps = false. // By default it is false. Written here for example.
  

  Above code will set text, “Hello Tutorialwing”, to Toggle Button without changing it to Uppercase.

  Actually, if isAllCaps is false, text is set as it is. It neither changes to uppercase nor lowercase.

  How do we set text in lowercase?

  Answer –

  • In xml file – write all the text in lowercase.
  • In kotlin file – take text as string. Then, convert it in lowercase. Then, set it to toggleButton.

Learn to Set Text in Uppercase or Lowercase Using XML Attribute

Set Size of Text in Toggle Button

Follow steps below to set size of Toggle Button programmatically using toggleButton.textSize attribute –

• Open res/values/dimens.xml file. Then, add below font-size in it –

  <dimen name="text_size">16sp</dimen>
  

• Now, using toggleButton.textSize attribute, we can set size of text dynamically as –

  toggleButton.textSize = resources.getDimension(R.dimen.text_margin)
  

Learn to Set Size of Text in Toggle Button Using XML Attribute

Set Style (Bold/italic) of Text in Toggle Button

We can set textStyle of Toggle Button programmatically as –

toggleButton.typeface = Typeface.DEFAULT_BOLD;

In above case, we have set textStyle as bold. So, text of Toggle Button will be displayed as bold letters.

If we want to preserve previous textStyle too, we can do it as –

toggleButton.setTypeface(toggleButton.typeface, Typeface.BOLD);

Learn to Set Typeface of Toggle Button Using XML Attribute

Set Letter Spacing of Text in Toggle Button

Follow steps below to set letter spacing of Toggle Button programmatically –

• Open res/values/dimens.xml file. Then, add below dimension in it –

  <dimen name="text_letter_spacing">1dp</dimen>
  

• We use toggleButton.letterSpacing attribute to set letter spacing of Toggle Button as below –

  toggleButton.letterSpacing = resources.getDimension(R.dimen.text_letter_spacing)
  

Learn to Set Letter Spacing of Toggle Button Using XML Attribute

That’s end of tutorial on Toggle Button Programmatically in Kotlin With Example.