@ Control

Определяет атрибуты, характерные для пользовательских элементов управления (ASCX-файлов), которые используются анализатором и компилятором страниц ASP.NET. Эта директива может использоваться только с объектам, исходный код которых содержится в файлах ASCX). Дополнительные сведения о пользовательских элементах управления см. в разделе Пользовательские элементы управления ASP.NET.

<%@ Control attribute="value" [attribute="value" ... ] %>

Атрибуты

• AutoEventWireup
  Указывает, будут ли события элемента управления автоматически связываться друг с другом. true, если включена автоматическая запись события; в противном случае false. Значение по умолчанию — true. Дополнительные сведения см. в разделе Модель событий серверного веб-элемента управления ASP.NET.

• ClassName
  Строка, указывающая для элемента управления имя класса, который будет динамически компилироваться при запросе этого элемента. Этим значением может быть любое действительное имя класса, и оно может включать полное пространство имен класса (полное имя класса). Если для данного атрибута значение не указано, имя класса для скомпилированного элемента управления создается на основе имени файла этого элемента.

  Другая страница или элемент управления может ссылаться на назначенное элементу управления имя класса с помощью директивы @ Reference.

• ClientIDMode
  Задает алгоритм, используемый для формирования значений ClientID для элементов управления. Значение для страницы по умолчанию равно AutoID.

  По умолчанию для элементов управления установлено значение Inherit. Соответственно, алгоритм по умолчанию для пользовательского элемента управления определяется его параметром ClientID. Другое значение по умолчанию может быть задано на уровне страницы в директиве @ Page или в элементе pages файла Web.config. Дополнительные сведения об алгоритмах см. в описании ClientIDMode.

• CodeBehind
  Задает имя откомпилированного файла, содержащего связанный с элементом управления класс. Этот атрибут не используется во время выполнения.

  Примечание
  Этот атрибут включен для обеспечения совместимости с предыдущими версиями ASP.NET и используется для реализации функции кода программной части.Чтобы задать имя исходного файла в ASP.NET версии 2.0, следует использовать атрибут CodeFile, а чтобы задать полное имя класса — атрибут Inherits.

• CodeFile
  Задает путь к указываемому файлу кода программной части для элемента управления. Для связи исходного файла кода программной части с пользовательским элементом управления этот атрибут используется вместе с атрибутом Inherits. Атрибут является допустимым только для скомпилированных элементов управления.

• CodeFileBaseClass
  Задает путь к базовому классу для элемента управления и связанного с ним класса с выделенным кодом. Этот атрибут является необязательным, однако если он используется, то также должен присутствовать атрибут CodeFile. Данный атрибут применяется при реализации общего сценария, в котором в базовом классе определяются общие поля (и дополнительно связанные события) для ссылки на элементы управления, объявленные в пользовательском элементе управления. В связи с особенностями модели создания кода ASP.NET, при определении полей в базовом классе без использования данного атрибута во время компиляции будут созданы новые определения членов для элементов управления, объявленных в пользовательском элементе (в заглушке отдельного разделяемого класса), и требуемый сценарий не будет работать. Однако если атрибут CodeFileBaseClass используется для связи базового класса с пользовательским элементом управления и частичный класс (его имя назначено атрибуту Inherits и на его исходный файл ссылается атрибут CodeFile) наследуется из базового класса, то после создания кода поля в базовом классе смогут ссылаться на элементы управления в пользовательском элементе.

• CompilationMode
  Указывает, должна ли для компиляции элемента управления использоваться строка, определяющая один из нескольких перечисляемых параметров. По умолчанию используется значение Always, поэтому компиляция элементов управления .aspx выполняется по умолчанию. Дополнительные сведения см. в описании перечисления CompilationMode.

• CompilerOptions
  Строка, содержащая параметры компилятора, используемые для компиляции элемента управления. Для C# и Visual Basic эта строка представляет собой последовательность переключателей командной строки компилятора. Дополнительные сведения о параметрах компилятора см. в разделе Параметры компилятора C# или Компилятор Visual Basic.

• Debug
  Указывает, должен ли элемент управления компилироваться с помощью символов отладки. Если для компиляции элемента управления должны использоваться символы отладки, следует задать значение true; в противном случае — значение false. Поскольку данный параметр влияет на производительность, во время разработки данный атрибут должен иметь значение true.

• Description
  Предоставляет текстовое описание элемента управления. Это значение не обрабатывается анализатором ASP.NET.

• EnableTheming
  Указывает, используются ли темы в элементе управления. true, если темы используются, в противном случае – false. Значение по умолчанию — true.

• EnableViewState
  Указывает, сохраняется ли состояние отображения в запросах к элементам управления. true, если состояние просмотра поддерживается; в противном случае false. Значение по умолчанию — true.

• Explicit
  Определяет, компилируется ли элемент управления с помощью режима Option Explicit Visual Basic. Значение true указывает, что включен параметр Visual Basic explicit и что все переменные должны объявляться с помощью инструкций Dim, Private, Public и ReDim; в противном случае — значение false. Значение по умолчанию — false.

  Примечание
  Этот атрибут не обрабатывается для языков, отличных от Visual Basic.Кроме того, для этого параметра устанавливается значение true в файле конфигурации Machine.config.Дополнительные сведения см. в разделах Файлы конфигурации и Файлы конфигурации ASP.NET.

• Inherits
  Определяет класс с выделенным кодом для элемента управления. Им может быть любой класс, производный от класса UserControl. Используется с атрибутом CodeFile, содержащим путь к исходному файлу для класса кода программной части. Дополнительные сведения о классах кода программной части см. в разделе Модель кода веб-страниц ASP.NET.

• Language
  Задает язык, используемый при компиляции всех находящихся внутри элемента управления встроенных блоков выполнения (<% %> and <%= %>) и объявлений кода. Значение может быть любым поддерживаемым .NET Framework языком, включая Visual Basic, C# или JScript. Для каждого элемента управления используется и задается только один язык.

• LinePragmas
  Определяет, должна ли среда выполнения создавать прагмы в исходном коде. Эти параметры компилятора часто используются средствами отладки для отметки определенных мест в исходном файле. true, если следует создавать строковые прагмы; в противном случае false.

• Src
  Задает путь к исходному файлу, содержащему связанный с элементом управления код. В связанном исходном файле использовать логику программирования для элемента управления можно как в классе, так и в блоках объявлений кода.

  Атрибут Src используется для связи поставщиков построения с элементом управления. Дополнительные сведения см. в описании класса BuildProvider. В версиях ASP.NET, предшествовавших версии 2.0, атрибут Src применялся в качестве альтернативы для связи файла кода программной части с элементом управления. В ASP.NET версии 2.0 рекомендуемым способом связи исходного файла фонового кода с элементом управления является использование атрибута Inherits для определения класса, а также атрибута CodeFile для задания пути к исходному файлу для класса.

• Strict
  Указывает, что элемент управления должен компилироваться с помощью режима Option Strict Visual Basic. true, если Option Strict включен, в противном случае — false. Значение по умолчанию — false.

  Примечание
  Этот атрибут не обрабатывается для языков, отличных от Visual Basic.

• TargetSchema
  Задает имя схемы, которая служит для проверки содержимого в элементе управления. Она используется только в описательных целях. В действительности проверка не производится и анализатор не обрабатывает атрибут.

• WarningLevel
  Определяет уровень предупреждений компилятора, при котором он будет рассматривать предупреждения как ошибки, прерывая, таким образом, компиляцию элемента управления. Возможные пороги предупреждений — от 0 до 4. Дополнительные сведения см. в описании свойства WarningLevel.

Заметки

Эта директива может использоваться только в пользовательских элементах управления. Пользовательские элементы управления определяются в файлах с расширением .ascx. Один файл .ascx может содержать только одну директиву @ Control. Для каждой директивы @ Control определяется только один атрибут Language, поскольку для элемента управления можно использовать только один язык.

Примечание
Директива @ Control располагает рядом атрибутов, общих для других директив, которые применяются ко всему исходному файлу, например директива @ Page (используется в файлах .aspx для веб-страниц) и директива @ Master (используется в файлах .master для главных страниц).

Чтобы определить несколько атрибутов для директивы @ Control, каждую пару атрибут/значение следует разделить одиночным пробелом. При определении конкретного атрибута не следует использовать пробел с какой-либо стороны знака равенства (=), связывающего атрибут с его значением. Пример см. в разделе "Пример".

Пример

В приведенном ниже примере коде указывается, что компилятор страниц ASP.NET должен рассматривать Visual Basic как язык встраиваемого кода, а также запрещается хранение состояния представления HTTP-запросов с помощью атрибута EnableViewState.

<%@ Control Language="VB" EnableViewState="false" %>

См. также

Ссылки

Синтаксис директивы текстового шаблона

@ Page

Другие ресурсы

Синтаксис страницы ASP.NET

Пользовательские элементы управления ASP.NET