User Interface Naming Conventions

A user interface’s name has a structure with 5 fields, as the next example,

1 2 3 4 5
Prefix Sub-System Module Type Correlative
UI AA 999 A 99

Name Type Length Mandatory

Prefix Alphabetic 2 Yes
Sub-System Alphabetic 2 Yes
Module Numeric 3 Yes
Type Alphabetic 1 Yes, in case that is about transition's screens that are belong a
module or a sub-module.
Correlative Numeric 2 Yes, in case that there were several transition's screens with the
same type

Field Description
Prefix Identifies that is a user’s class interface. It is always UI.
Sub-System
1.1 Identifies a subsystem. It is always in capital letters.
Module Identifies sub-system’s modules. These values can be between 001 and 999.
Type Identifies auxiliary window’s types, module or sub-module’s transitions
Use the next values:
S – Search, to search’s pages.
R – Report, to report’s pages (.rpx)
D – Detail, to detail or auxiliary’s pages.
X – XML Providers or Ajax Provider
Correlative Used in case that there were several auxiliary pages with the same type. These values
can be between 01 and 99.

Example 1 – Module without details

SubSystem : General Ledger
Module : Multiple Ledger Maintenance

Name EXT Description

UI GL 002 .aspx General Ledger’s Principal screen (It contains principal actions)
UI GL 002 S .aspx General Ledger’s search screen
UI GL 002 R .rpx General Ledger’s report

Example 2 – Module with details

SubSystem : Account Payable
Module : Regular Invoices

Name EXT Description

UI AP 001 .aspx Regular Invoice’s principal screen (It contains principal actions)
UI AP 001 S .aspx Regular Invoice’s search screen
0
UI AP 001 D .aspx Purchase Order’s auxiliary selection screen, to regular invoice’s items
1
0
UI AP 001 D .aspx Difference Reason’s details page using regular invoice’s items.
2
UI AP 001 R .rpx Regular Invoice’s report.
ASP.NET User Interface Components Naming Conventions

Component Prefix Example

AdRotator adrt adrtTop
Button btn btnSubmit
Calendar cal calMeetingDate
CheckBox chk chkValue
CheckBoxList chkl chklFactors
CompareValidator valc valcAge
CustomValidator valx valxEmail
DataGrid dgrd dgrdBooking
DataList dlst dlstTitles
DropDownList drop dropCountries
HyperLink lnk lnkDetails
Image img imgLogo
ImageButton ibtn ibtnSubmit
Label lbl lblResults
LinkButton lbtn lbtnSubmit
ListBox lst lstCountries
Panel pnl pnlForm
PlaceHolder plh plhForm
RadioButton rad radFemale
RadioButtonList radl radlGender
RangeValidator valg valgAge
RegularExpressionValidator vale valeEmail
Repeater rpt rptQueryResults
RequiredFieldValidator valr valrFirstName
Table tbl tblCountryCode
TableCell tblc tblcGermany
TableRow tblr tblrCountry
TextBox txt txtFirstName
ValidationSummary vals valsFormsErrors
XML xml xmlTransformResults
Connection con conShippNet
Command cmd cmdReturnProducts
Parameter parm parmProductId
DataAdapter dad dadProducts
DataReader dtr dtrProducts
DataSet dst dstBill
DataTable dtbl dtblProducts
DataRow drow drowInitial
DataColumn dcol dcolProductId
DataRelation drel drelMasterDetail
DataView dvw dvwFilteredProducts
TssToolBar tbar tbarMaintenance
TssDateTimePicker dtp dtpDepartureDate
TssSearchRequester srq srqPort
TssSearchReplier srp srpPorts
TssButton btn btnDelete
To help when scripting database objects the following prefix list should be used:

Object Prefix Complete Name Example Comments

Tables Module Module + purpose CustomerAddress When is applicable use the prefix
“module”
Views v Module + purpose vCustomerReport When is applicable use the prefix
“module”
Stored Procedures spu spu + module+ purpose spuBillGenerateImage When is applicable use the prefix
“module”
Constraint Primary key pk pk + TableName pkCustomerAddress
Constraint Foreign key fk fk + TableName + ColumnName fkCustomerAddress_CustomerId
Constraint Check ck ck + TableName + ColumnName ckCustomer_CustomerCode
Constraint Unique uk uk + TableName + ColumnName ukCustomer_Name
Constraint Default df df + TableName + ColumnName dfCustomer_ActiveFlag
Cursors cur cur + purpose curInboundVoyage
Rules Avoid to use
Defaults Avoid to use
User Defined types
Triggers trd, tri, tru triCustomer
User Defines functions uf uf + purpose ufGetId
Index TableName + idx + sequence CustomerAddress_idx1
APPENDIX A Reserved Words
The following words are considered reserved for .NET code. This chart does not include the
universal types or the standard language names which are also considered reserved. Some of
these words are no longer considered reserved words by some languages but are still contained
in this table and should be avoided.

Abstract Add AddHandler AddressOf Alias

And AndAlso Ansi As Assembly
Auto Base Binary Bool Boolean
Break ByRef Byte ByVal Call
Case Catch CBool CByte CChar
CDate CDbl CDec Char Checked
CInt Class CLng CObj Compare
Const Continue CSByte CShort CSng
CStr CType CUInt CULng CUShort
Custom Date Decimal Declare Default
Delegate Delete Dim DirectCast Do
Double Each Else ElseIf End
EndIf Enum Erase Error Eval
Event Exit Explicit Extends Extern
ExternalSource False Finalize Finally Fixed
Float For ForEach Friend Function
Get GetType Global GoSub Goto
Handles If Implements Implicit Imports
In Inherits InstanceOf Int Integer
Interface Internal Is IsFalse IsNot
IsTrue Let Lib Like Lock
Long Loop Me Mid Mod
Module MustInherit MustOverride MyBase MyClass
Namespace Narrowing New Next Not
Nothing NotInheritable NotOverridable Null Object
Of Off On Operator Option
Optional Or OrElse Out Overloads
Overridable Override Overrides Package Params
ParamArray Partial Preserve Private Property
Protected Public RaiseEvent ReadOnly ReDim
Ref Region REM Remove RemoveHandler
Resume Return SByte Sealed Select
Set Shadows Shared Short Single
SizeOf StackAlloc Static Step Stop
Strict String Struct Structure Sub
Switch SyncLock Text Then This
Throw To True Try TryCast
TypeOf UInt UInteger ULong Unchecked
Unicode Union Unsafe Until UShort
Using Var Variant Virtual Void
Volatile Wend When Where While
Widening With WithEvents WriteOnly Xor
Table 1 Keywords
APPENDIX B Type Names
The following table contains the types commonly used in .NET.

Universal Name C# Name C++ Name VB Name

Boolean bool bool Boolean
Byte byte unsigned char Byte
Char char wchar_t Char
Decimal decimal n/a Decimal
Double double double Double
Int16 short short Short
Int32 int int Integer
Int64 long __int64 Long
Object object object Object
Single float float Single
SByte sbyte char SByte
String string String String
UInt16 ushort unsigned short UInt16
UInt32 uint unsigned int UInt32
UInt64 ulong unsigned __int64 UInt64
Table 2 Universal Type Names