WoWWiki-Asmodai@legacy41582652 (talk | contribs) (Cast in a standard form.) |
BobClown7094@legacy41528359 (talk | contribs) m (→Notes) |
||
(11 intermediate revisions by 7 users not shown) | |||
Line 1: | Line 1: | ||
+ | {{widgetmethod}} |
||
− | <center>'''GetFrameType''' ''-Documentation by [[user:Darjk|Darjk]]-''</center> |
||
== Synopsis == |
== Synopsis == |
||
− | + | string frameType = Frame:GetFrameType(); |
|
== Description == |
== Description == |
||
− | This returns the type of frame |
+ | This returns the type of the frame the GetFrameType() method is used on. |
+ | It will return a string of the name of the Frame(-derived) object. For a complete list see [[API Object Types|object types]] |
||
− | 'this' is any Frame or Frame derivative widget (also known as objects, or elements). |
||
− | The purpose of this function is so you can find out what the frame type is. |
||
− | It can return, "Frame", "Button", "EditBox", "ScrollingFrame", etc. Basically any widget that is derived from the original Frame widget. |
||
+ | == Return values == |
||
− | "FontString", "Texture", etc are NOT derived from the type Frame, but are derived from the LayoutFrame, so this function does not work with those objects. |
||
− | |||
⚫ | |||
:;frameType : String - The name of the type, ie. "Frame" |
:;frameType : String - The name of the type, ie. "Frame" |
||
== Examples == |
== Examples == |
||
− | local frameType = |
+ | local frameType = QuestLogCollapseAllButton:GetFrameType(); |
+ | The above should return the string "Button" in local variable frameType. |
||
− | ====Result==== |
||
− | frameType = "Button" |
||
⚫ | |||
− | <br><center><i>Last updated: Patch 1.9.2</i></center> |
||
+ | * This method may not exist for all Frames. |
||
− | ---- |
||
− | __NOTOC__ |
||
− | {{Template:WoW API}} |
||
− | [[Category:API Sub Functions|Empty Template]] |
Revision as of 16:22, 17 July 2008
The API is no longer being updated here until further notice. |
Synopsis
string frameType = Frame:GetFrameType();
Description
This returns the type of the frame the GetFrameType() method is used on.
It will return a string of the name of the Frame(-derived) object. For a complete list see object types
Return values
- frameType
- String - The name of the type, ie. "Frame"
Examples
local frameType = QuestLogCollapseAllButton:GetFrameType();
The above should return the string "Button" in local variable frameType.
Notes
- This method may not exist for all Frames.