Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://js.devexpress.com/Vue/Documentation/ApiReference/UI_Components/dxTagBox/Methods/ below:

Vue TagBox Methods | Vue Documentation

This section describes members used to manipulate data.

Postpones rendering that can negatively affect performance until the endUpdate() method is called.

The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.

Removes focus from the input element.

Resets the value property to the default value.

Closes the drop-down editor.

Gets the popup window's content.

Specifies the device-dependent default configuration properties for this component.

The component's default device properties.

Object structure:

Device

Function

Device parameters.
When you specify a function, get information about the current device from the argument. Return true if the properties should be applied to the device.

Object

Options to be applied.

defaultOptions is a static method that the UI component class supports. The following code demonstrates how to specify default properties for all instances of the TagBox UI component in an application executed on the desktop.

DevExpress.ui.dxTagBox.defaultOptions({ 
    device: { deviceType: "desktop" },
    options: {
        // Here go the TagBox properties
    }
});

import TagBox, { Properties } from "devextreme/ui/tag_box";
// ...
export class AppComponent {
    constructor () {
        TagBox.defaultOptions<Properties>({
            device: { deviceType: "desktop" },
            options: {
                // Here go the TagBox properties
            }
        });
    }
}

<template>
    <div>
        <DxTagBox id="tagBox1" />
        <DxTagBox id="tagBox2" />
    </div>
</template>
<script>
import DxTagBox from "devextreme-vue/tag-box";
import TagBox from "devextreme/ui/tag_box";

TagBox.defaultOptions({
    device: { deviceType: "desktop" },
    options: {
        // Here go the TagBox properties
    }
});

export default {
    components: {
        DxTagBox
    }
}
</script>

import dxTagBox from "devextreme/ui/tag_box";
import TagBox from "devextreme-react/tag-box";

dxTagBox.defaultOptions({
    device: { deviceType: "desktop" },
    options: {
        // Here go the TagBox properties
    }
});

export default function App() {
    return (
        <div>
            <TagBox id="tagBox1" />
            <TagBox id="tagBox2" />
        </div>
    )
}

You can also set rules for multiple device types:

const devicesConfig = [
    { deviceType: 'desktop' },
    { deviceType: 'tablet' },
    { deviceType: 'phone' },
];

devicesConfig.forEach(deviceConfig => {
    DevExpress.ui.dxTagBox.defaultOptions({ 
        device: deviceConfig,
        options: {
            // Here go the TagBox properties
        }
    });
});

import TagBox, { Properties } from "devextreme/ui/tag_box";
// ...
export class AppComponent {
    constructor () {
        const devicesConfig = [
            { deviceType: 'desktop' },
            { deviceType: 'tablet' },
            { deviceType: 'phone' },
        ];

        devicesConfig.forEach(deviceConfig => {
            TagBox.defaultOptions<Properties>({
                device: deviceConfig,
                options: {
                    // Here go the TagBox properties
                }
            });
        });
    }
}

<template>
    <div>
        <DxTagBox />
    </div>
</template>
<script>
import DxTagBox from "devextreme-vue/tag-box";
import TagBox from "devextreme/ui/tag_box";

const devicesConfig = [
    { deviceType: 'desktop' },
    { deviceType: 'tablet' },
    { deviceType: 'phone' },
];

devicesConfig.forEach(deviceConfig => {
    TagBox.defaultOptions({
        device: deviceConfig,
        options: {
            // Here go the TagBox properties
        }
    });
});

export default {
    components: {
        DxTagBox
    }
}
</script>

import dxTagBox from "devextreme/ui/tag_box";
import TagBox from "devextreme-react/tag-box";

const devicesConfig = [
    { deviceType: 'desktop' },
    { deviceType: 'tablet' },
    { deviceType: 'phone' },
];

devicesConfig.forEach(deviceConfig => {
    dxTagBox.defaultOptions({
        device: deviceConfig,
        options: {
            // Here go the TagBox properties
        }
    });
});

export default function App() {
    return (
        <div>
            <TagBox />
        </div>
    )
}

Disposes of all the resources allocated to the TagBox instance.

After calling this method, remove the DOM element associated with the UI component:

$("#myTagBox").dxTagBox("dispose");
$("#myTagBox").remove();

Use conditional rendering instead of this method:

<dx-tag-box ...
    *ngIf="condition">
</dx-tag-box>

Use conditional rendering instead of this method:

<template>
    <DxTagBox ...
        v-if="condition">
    </DxTagBox>
</template>

<script>
import DxTagBox from 'devextreme-vue/tag-box';

export default {
    components: {
        DxTagBox
    }
}
</script>

Use conditional rendering instead of this method:

import React from 'react';

import TagBox from 'devextreme-react/tag-box';

function DxTagBox(props) {
    if (!props.shouldRender) {
        return null;
    }

    return (
        <TagBox ... >    
        </TagBox>
    );
}

class App extends React.Component {
    render() {
        return (
            <DxTagBox shouldRender="condition" />
        );
    }
}
export default App;

Gets the root UI component element.

Refreshes the UI component after a call of the beginUpdate() method.

The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.

Gets the UI component's <input> element.

Sets focus to the input element representing the UI component.

Gets an instance of a custom action button.

Button

| undefined

The Button UI component's instance.

Use the returned button instance to call the Button UI component's methods, for example, focus():

const myCustomButton = $("#tagBoxContainer").dxTagBox("getButton", "myCustomButton");
myCustomButton.focus();

import { Component, ViewChild } from '@angular/core';
import { DxTagBoxComponent } from 'devextreme-angular';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    @ViewChild('tagBoxRef', { static: false }) tagBox: DxTagBoxComponent;
    // Prior to Angular 8
    // @ViewChild('tagBoxRef') tagBox: DxTagBoxComponent;

    setFocus() {
        this.tagBox.instance.getButton('myCustomButton').focus();
    }
}

<dx-tag-box #tagBoxRef ... >
</dx-tag-box>

<template>
    <DxTagBox ...
        :ref="tagBoxRef">
    </DxTagBox>
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxTagBox from 'devextreme-vue/tag-box';

export default {
    components: {
        DxTagBox
    },

    data() {
        return {
            tagBoxRef
        }
    },

    methods: {
        setFocus() {
            this.tagBox.getButton('myCustomButton').focus();
        }
    },

    computed: {
        tagBox: function() {
            return this.$refs[tagBoxRef].instance;
        }
    }
}
</script>

import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import TagBox from 'devextreme-react/tag-box';

class App extends React.Component {
    constructor(props) {
        super(props);

        this.tagBoxRef = React.createRef();

        this.setFocus = () => {
            this.tagBox.getButton('myCustomButton').focus();
        };
    }

    get tagBox() {
        return this.tagBoxRef.current.instance();
    }

    render() {
        return (
            <TagBox ...
                ref={this.tagBoxRef}>
            </TagBox>
        );
    }
}
export default App;

Gets the instance of a UI component found using its DOM node.

The UI component's container.

The UI component's instance.

getInstance is a static method that the UI component class supports. The following code demonstrates how to get the TagBox instance found in an element with the myTagBox ID:

// Modular approach
import TagBox from "devextreme/ui/tag_box";
...
let element = document.getElementById("myTagBox");
let instance = TagBox.getInstance(element) as TagBox;

// Non-modular approach
let element = document.getElementById("myTagBox");
let instance = DevExpress.ui.dxTagBox.getInstance(element);

• 3rd-Party Frameworks Integration API

Gets the UI component's instance. Use it to access other methods of the UI component.

This UI component's instance.

Detaches all event handlers from a single event.

The object for which this method is called.

Detaches a particular event handler from a single event.

The event's name.

The event's handler.

The object for which this method is called.

Subscribes to an event.

The event's name.

The event's handler.

The object for which this method is called.

Use this method to subscribe to one of the events listed in the Events section.

Subscribes to events.

Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}

The object for which this method is called.

Use this method to subscribe to several events with one method call. Available events are listed in the Events section.

Opens the drop-down editor.

Gets the value of a single property.

The property's name or full path.

Return Value: any

This property's value.

Updates the value of a single property.

The property's name or full path.

optionValue: any

This property's new value.

Updates the values of several properties.

Options with their new values.

Registers a handler to be executed when a user presses a specific key.

A key.

A handler. Accepts the keydown event as the argument. It is a EventObject or a jQuery.Event when you use jQuery.

The key argument accepts one of the following values:

• "backspace"
• "tab"
• "enter"
• "escape"
• "pageUp"
• "pageDown"
• "end"
• "home"
• "leftArrow"
• "upArrow"
• "rightArrow"
• "downArrow"
• "del"
• "space"
• "F"
• "A"
• "asterisk"
• "minus"

A custom handler for a key cancels the default handler for this key.

Renders the component again without reloading data. Use the method to update the component's markup and appearance dynamically.

Resets the value property to the value passed as an argument.

Resets a property to its default value.

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4