Move page script: Move page script moved page API UIObject GetName to WoW:API UIObject GetName without leaving a redirect

2023-08-15T04:47:41Z

Move page script moved page API UIObject GetName to API UIObject GetName without leaving a redirect

← Older revision	Revision as of 04:47, 15 August 2023
(No difference)

Bear: Created page with "{{widgetmethod}} This function obtains the value of the current XML object. E.g. WorldFrame:GetName() returns "WorldFrame". local name = uiobject:GetName() == Parameters..."

2021-02-13T02:38:09Z

Created page with "{{widgetmethod}} This function obtains the value of the current XML object. E.g. WorldFrame:GetName() returns "WorldFrame". local name = uiobject:GetName() == Parameters..."

New page

{{widgetmethod}}

Obtains the name of a Widget or other {{apiwidget|UIObject}}.

local name = uiobject:GetName()

== Parameters ==
=== Returns ===
* name (string) - the name of the UI object, or 'nil' if no name

== Summary ==
Obtains the name of an object. Great for a lot of uses, like generic object handling functions.

== Examples ==
;Get the name of a default frame
local name = PlayerFrame:GetName()
Result:
name = "PlayerFrame"

;Create a frame in Lua with a name
/dump CreateFrame("Frame", "MyFrame"):GetName()
Result:
MyFrame

== Details ==
Frames and other elements created from XML with a 'name' attribute will set the UIObjects name to the value in the 'name' attribute when they are created, and add a global reference with the same name to the Lua object, like:
<Frame name="PlayerFrame">
...
</Frame>

Gets a default global reference:
_G[playerFrame:GetName()] = playerFrame

This is why 'PlayerFrame' in the first [[#examples|example]] above has the same name as its global variable name, and why so many other default frames follow the same pattern.

== Notes ==
* Moved in patch 1.10.0 from {{apiwidget|Region:GetName}} to {{apiwidget|UIObject}}

== See also ==
* {{xmlattr|name}} - XML name attribute
* {{xml|LayoutFrame}} - XML base frame type with name property

WoW:API UIObject GetName - Revision history

Move page script: Move page script moved page API UIObject GetName to WoW:API UIObject GetName without leaving a redirect

Bear: Created page with "{{widgetmethod}} This function obtains the value of the current XML object. E.g. WorldFrame:GetName() returns "WorldFrame". local name = uiobject:GetName() == Parameters..."