From WikiChip
Difference between revisions of "mirc/commands/aline"
< mirc‎ | commands

(Created page with "The '''aline command''' is used to add a single line of text to a custom window or a list. This command is limited to custom @windows, If you need a more general command that ...")
 
(Example)
 
(27 intermediate revisions by 6 users not shown)
Line 1: Line 1:
The '''aline command''' is used to add a single line of text to a custom window or a list. This command is limited to custom @windows, If you need a more general command that is able to print to both custom windows, channel, and query consider using the /echo command instead.
+
{{mirc title|/aline Command}}
 +
The '''aline command''' is used to add a single line of text to a custom window. This command is limited to custom @windows, If you need a more general command that is able to print to both custom windows, channel, and query consider using the /echo command instead.
 +
 
 +
'''Note:''' If the main window is sorted (text or listbox and /window -s has been used), lines added with /echo to that window won't be sorted, only lines added with /aline will.
  
 
== Synopsis ==
 
== Synopsis ==
  /aline -sahpinl [c] <@name> <text>
+
  /aline -scNahpinlt [c] <@name> <text>
  
 
== Switches ==
 
== Switches ==
* '''-s''' - Clears the old selection in a list and selects the newly added item  
+
* '''-s''' - Clears the old selection in a listbox and selects the newly added item  
* '''-a''' - Selects the newly added item while keeping the old selection in a list
+
* '''-a''' - Selects the newly added item while keeping the old selection in a listbox
* '''-h''' - Highlights the window's node in the treebar is the window is minimized
+
* '''-h''' - Highlights the window's node in the treebar/switchbar if the window is minimized
* '''-p''' - Forces the line to be wrapped if it's too long to fit in on one line (does not apply to lists)
+
* '''-p''' - Forces the line to be wrapped if it's too long to fit in on one line (does not apply to listboxes)
* '''-i''' - Indent the newly added line
+
* '''-i[N]''' - Indent the newly added line (does not apply to listboxes) by N spaces, default to 2 spaces
* '''-n''' - Prevent the line from being added if already exists
+
* '''-n''' - Prevent the line from being added if it already exists
 
* '''-l''' - Specify the action to take place on the side-listbox
 
* '''-l''' - Specify the action to take place on the side-listbox
 +
* '''-t''' - forces a re-wrap of all lines in a window that have not yet been wrapped to the current window size.
 +
* '''-cN''' - Same as specifying the [c] parameter for the color of the line but via a switch
  
 
== Parameters ==
 
== Parameters ==
  
* '''[c]''' - An optional color number for the line
+
* '''[c]''' - An optional color number for the line.
* '''<@name>''' - The name of the window
+
* '''<@name>''' - The name of the window.
* '''<text>''' - The text to be added
+
* '''<text>''' - The text to be added.
  
 
== Example ==
 
== Example ==
<syntaxhighlight lang="mIRC">Alias Example {
+
<syntaxhighlight lang="mIRC">alias example {
   ;open a desktop custom window (listbox and with an editbox)
+
   ;open a desktop custom window (main window is a listbox, no side-listbox and with an editbox)
   Window -lde @Foo
+
   window -lde @Foo
  
 
   ;Add a line, line colored in yellow (8)
 
   ;Add a line, line colored in yellow (8)
   Aline 8 @Foo Line A
+
   aline 8 @Foo Line A
  
 
   ;Add a line, color Dark Green (3), selected, clear old selection
 
   ;Add a line, color Dark Green (3), selected, clear old selection
   Aline -s 3 @Foo Line B
+
   aline -s 3 @Foo Line B
 
}</syntaxhighlight>
 
}</syntaxhighlight>
  
 
== Compatibility ==
 
== Compatibility ==
Added: mIRC v5.0
+
{{mIRC compatibility|5.0}}
 
 
Added On: 02/04/97
 
 
 
<small>Note: Individual switches were not taken into consideration.</small>
 
  
 
== See also ==
 
== See also ==
 
* [[List of commands - mIRC|List of commands]]
 
* [[List of commands - mIRC|List of commands]]
 
* [[List of identifiers - mIRC|List of identifiers]]
 
* [[List of identifiers - mIRC|List of identifiers]]
* [[$line identifier - mIRC|$line]]
+
* {{mIRC|$line}}
* [[$fline identifier - mIRC|$fline]]
+
* {{mIRC|$fline}}
* [[$slinex identifier - mIRC|$slinex]]
+
* {{mIRC|$sline}}
* [[cline identifier - mIRC|cline]]
+
* {{mIRC|/cline}}
* [[dline identifier - mIRC|dline]]
+
* {{mIRC|/dline}}
* [[echo identifier - mIRC|echo]]
+
* {{mIRC|/echo}}
* [[iline identifier - mIRC|iline]]
+
* {{mIRC|/iline}}
* [[rline identifier - mIRC|rline]]
+
* {{mIRC|/rline}}
* [[sline identifier - mIRC|sline]]
+
* {{mIRC|/sline}}
* [[window identifier - mIRC|window]]
+
* {{mIRC|/window}}
 +
{{mIRC command list}}
  
[[Category:mIRC commands]]
+
[[Category:mIRC commands|aline command - mIRC]]

Latest revision as of 12:26, 29 October 2024

The aline command is used to add a single line of text to a custom window. This command is limited to custom @windows, If you need a more general command that is able to print to both custom windows, channel, and query consider using the /echo command instead.

Note: If the main window is sorted (text or listbox and /window -s has been used), lines added with /echo to that window won't be sorted, only lines added with /aline will.

Synopsis[edit]

/aline -scNahpinlt [c] <@name> <text>

Switches[edit]

  • -s - Clears the old selection in a listbox and selects the newly added item
  • -a - Selects the newly added item while keeping the old selection in a listbox
  • -h - Highlights the window's node in the treebar/switchbar if the window is minimized
  • -p - Forces the line to be wrapped if it's too long to fit in on one line (does not apply to listboxes)
  • -i[N] - Indent the newly added line (does not apply to listboxes) by N spaces, default to 2 spaces
  • -n - Prevent the line from being added if it already exists
  • -l - Specify the action to take place on the side-listbox
  • -t - forces a re-wrap of all lines in a window that have not yet been wrapped to the current window size.
  • -cN - Same as specifying the [c] parameter for the color of the line but via a switch

Parameters[edit]

  • [c] - An optional color number for the line.
  • <@name> - The name of the window.
  • <text> - The text to be added.

Example[edit]

alias example {
  ;open a desktop custom window (main window is a listbox, no side-listbox and with an editbox)
  window -lde @Foo
 
  ;Add a line, line colored in yellow (8)
  aline 8 @Foo Line A
 
  ;Add a line, color Dark Green (3), selected, clear old selection
  aline -s 3 @Foo Line B
}

Compatibility[edit]

Added: mIRC v5.0
Added on: 02 Apr 1997
Note: Unless otherwise stated, this was the date of original functionality.
Further enhancements may have been made in later versions.


See also[edit]

v · d · e mIRC commands list

A /abook, /action, /add, /ajinvite, /alias, /aline, /ame, /amsg, /anick, /aop, /auser, /auto, /autojoin, /avoice, /away

B /background, /ban, /bcopy, /beep, /bindip, /bread, /break, /breplace, /bset, /btrunc, /bunset, /bwrite

C /channel, /clear, /clearall, /clearial, /cline, /clipboard, /close, /closechats, /closedccs, /closefserves, /closemsg, /cnick, /color, /colour, /comclose, /comlist, /commands, /comopen, /comreg, /continue, /copy, /creq, /ctcp, /ctcpreply, /ctcps

D /dcc, /dccserver, /dde, /ddeserver, /debug, /dec, /describe, /dialog, /did, /didtok, /disable, /disconnect, /dlevel, /dline, /dll, Template:mIRC/donotdisturb, /dns, /dqwindow, /drawcopy, /drawdot, /drawfill, /drawline, /drawpic, /drawrect, /drawreplace, /drawrot, /drawsave, /drawscroll, /drawsize /drawtext

E /ebeeps, /echo, /editbox, /else, /elseif, /emailaddr, /enable, /events, /exit

F /fclose, /filter, /findtext, /finger, /firewall, /flash, /flist, /flood, /flush, /flushini, /fnord, /font, /fopen, /fseek, /fsend, /fserve, /fullname, /fupdate, /fwrite

G /ghide, /gload, /gmove, /gopts, /goto, /gplay, /gpoint, /gqreq, /groups, /gshow, /gsize, /gstop, /gtalk, /gunload, /guser

H /hadd, /halt, /haltdef, /hdec, /hdel, /help, /hfree, /hinc, /hload, /hmake, /hotlink, /hop, /hsave

I /ial, /ialclear, /ialmark, /identd, /if, /ignore, /iline, /inc, /iuser

J /join

L /leave, /linesep, /links, /list, /load, /loadbuf, /localinfo, /log, /logview

M /maxdepth, /mdi, /me, /menubar, /mkdir, /mnick, /mode, /msg

N /noop, /notice, /notify

O /onotice, /omsg

P /pareline, /part, /partall, /pdcc, /perform, /play, /playctrl, /pop, /protect, /proxy, /pvoice

Q /qme, /qmsg, /query, /queryrn, /quit, /quote

R /raw, /registration, /reload, /remini, /remote, /remove, /rename, /renwin, /reseterror, /resetidle, /return, /returnex, /rlevel, /rline, /rmdir, /run, /ruser

S /save, /savebuf, /saveini, /say, /scid, /scon, /server, /set, /setlayer, /showmirc, /signal, /sline, /sockaccept, /sockclose, /socklist, /socklisten, /sockmark, /sockopen, /sockpause, /sockread, /sockrename, /sockudp, /sockwrite, /sound, /speak, /splay, /sreq, /strip, /switchbar

T /timer, /timestamp, /tip, /tips, /titlebar, /tnick, /tokenize, /toolbar, /topic /tray, /treebar

U /ulist, /unload, /unset, /unsetall, /updatenl, /url, /username, /uwho

V /var, /vcadd, /vcmd, /vcrem, /vol

W

X /xyzzy